From 618606ab3e98647250991623d242086397c34750 Mon Sep 17 00:00:00 2001 From: ebrillhart Date: Sun, 14 Oct 2018 14:36:54 -0700 Subject: [PATCH] add docs about spectacle mdx --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e31b79e12..af9a14036 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![Travis Status][trav_img]][trav_site] ReactJS based Presentation Library +[Spectacle Boilerplate MDX](https://github.com/FormidableLabs/spectacle-boilerplate-mdx/) [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate/) 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 ## Getting Started +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. + +### Classic Spectacle + There are three ways to get started on your presentation. The first way is to run the following command in your terminal: `npx create-react-app my-presentation --scripts-version spectacle-scripts` The second way to get started is by using the [Spectacle Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate). -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. +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. 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`. +### Spectacle MDX + +Download the [Spectacle MDX Boilerplate](https://github.com/FormidableLabs/spectacle-boilerplate-mdx). + +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. + _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`._