|
3 | 3 | [![Travis Status][trav_img]][trav_site] |
4 | 4 | ReactJS based Presentation Library |
5 | 5 |
|
| 6 | +[Spectacle Boilerplate MDX](https://github.com/FormidableLabs/spectacle-boilerplate-mdx/) |
6 | 7 | [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate/) |
7 | 8 |
|
8 | 9 | Have a question about Spectacle? Submit an issue in this repository using the "Question" template. |
@@ -63,16 +64,26 @@ Have a question about Spectacle? Submit an issue in this repository using the "Q |
63 | 64 |
|
64 | 65 | ## Getting Started |
65 | 66 |
|
| 67 | +First, decide whether you want to use classic Spectacle, or MDX Spectacle, which has all the same functionality but allows you to write your Spectacle presentation in markdown. |
| 68 | + |
| 69 | +### Classic Spectacle |
| 70 | + |
66 | 71 | There are three ways to get started on your presentation. The first way is to run the following command in your terminal: |
67 | 72 |
|
68 | 73 | `npx create-react-app my-presentation --scripts-version spectacle-scripts` |
69 | 74 |
|
70 | 75 | The second way to get started is by using the [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate). |
71 | 76 |
|
72 | | -Both of these ways will give you everything you'll need to get started, including a sample presentation in the `presentation.js` file. You can change the props and tags as needed for your presentation or remove the `Deck` tag and all its content to start from scratch. From here you can go to [Development](#development) to get started. |
| 77 | +Both of these ways will give you everything you'll need to get started, including a sample presentation in the `presentation` folder. You can change the props and tags as needed for your presentation or delete everying in `presentation/index.js` to start from scratch. From here you can go to [Development](#development) to get started. |
73 | 78 |
|
74 | 79 | The third way to get started is by running `npm install spectacle` in your terminal and writing your own build configurations. We also provide full UMD builds (with a `Spectacle` global variable) of the library at `dist/spectacle.js` and `dist/spectacle.min.js` for more general use cases. You could, for example, include the library via a script tag with: `https://unpkg.com/spectacle@VERSION/dist/spectacle.min.js`. |
75 | 80 |
|
| 81 | +### Spectacle MDX |
| 82 | + |
| 83 | +Download the [Spectacle MDX Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate-mdx). |
| 84 | + |
| 85 | +This repository will give you everything you'll need to get started, including a sample presentation in the `presentation` folder. You can change the props and tags as needed for your presentation or delete everything in the `index.mdx` file to start from scratch. From here you can go to [Development](#development) to get started. |
| 86 | + |
76 | 87 | _NOTE: We have webpack externals for `react`, `react-dom`, and `prop-types`, so you will need to provide them in your upstream build or something like linking in via `script` tags in your HTML page for all three libraries. This comports with our project dependencies which place these three libraries in `peerDependencies`._ |
77 | 88 |
|
78 | 89 | <a name="one-page"></a> |
|
0 commit comments