Skip to content

Commit 2d0c302

Browse files
authored
add docs about spectacle mdx (#602)
1 parent e9ea98f commit 2d0c302

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![Travis Status][trav_img]][trav_site]
44
ReactJS based Presentation Library
55

6+
[Spectacle Boilerplate MDX](https://github.com/FormidableLabs/spectacle-boilerplate-mdx/)
67
[Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate/)
78

89
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
6364

6465
## Getting Started
6566

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+
6671
There are three ways to get started on your presentation. The first way is to run the following command in your terminal:
6772

6873
`npx create-react-app my-presentation --scripts-version spectacle-scripts`
6974

7075
The second way to get started is by using the [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate).
7176

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.
7378

7479
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`.
7580

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+
7687
_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`._
7788

7889
<a name="one-page"></a>

0 commit comments

Comments
 (0)