├── .gitignore
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | package-lock.json
3 | dist
4 | *.log
5 | .DS_Store
6 | .vscode
7 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Spectacle Boilerplate (MDX)
 2 | ===========================
 3 | 
 4 | > ⚠️ **Deprecated**: This project has been deprecated. Please install [`spectacle-cli`](https://github.com/FormidableLabs/spectacle-cli) and use `spectacle-boilerplate` to generate your presentations with ease!
 5 | 
 6 | ## Generate a Spectacle presentation
 7 | 
 8 | First, install `spectacle-cli`:
 9 | 
10 | ```sh
11 | $ npm install -g spectacle-cli
12 | ```
13 | 
14 | > ℹ️ **Note**: If you would like to avoid a global install, you can use `npx -p spectacle-cli spectacle-boilerplate` in the place of the `spectacle-boilerplate` command below.
15 | 
16 | Then generate a new boilerplate Spectacle project!
17 | 
18 | ```sh
19 | $ spectacle-boilerplate -m mdx
20 | 
21 | # ... or with options! ...
22 | $ spectacle-boilerplate \
23 |   --mode "mdx" \
24 |   --name "deck-o-awesomeness" \
25 |   --description "My fantastic Spectacle presentation" \
26 |   --dir "PATH/TO/NEW/DECK/DIRECTORY"
27 | 
28 | # Check out the full usage
29 | $ spectacle-boilerplate -h
30 | ```
31 | 
32 | ## Author and build your project!
33 | 
34 | See the [boilerplate guide](https://github.com/FormidableLabs/spectacle-cli/blob/master/lib/templates/boilerplate/README.md) for full instructions. As a quick starter:
35 | 
36 | ```sh
37 | # Install your dependencies
38 | $ yarn
39 | 
40 | # Start development server at localhost:8080
41 | $ yarn start
42 | 
43 | # Create a production build for publishing
44 | $ yarn build
45 | ```
46 | 


--------------------------------------------------------------------------------