https://github.com/luandro/apresentacao-moinho-mesh
https://github.com/luandro/apresentacao-moinho-mesh
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/luandro/apresentacao-moinho-mesh
- Owner: luandro
- License: mit
- Created: 2019-03-21T09:30:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-28T03:32:00.000Z (about 7 years ago)
- Last Synced: 2025-03-01T05:18:39.466Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 20 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spectacle Boilerplate
## Contents
- [Reference](#reference)
- [Getting Started](#getting-started)
- [Build & Deployment](#build-deployment)
## Reference
The Spectacle core API is available at [https://github.com/FormidableLabs/spectacle/blob/master/README.md](https://github.com/FormidableLabs/spectacle/blob/master/README.md).
For more information about MDX syntax and how it all works, check out the [MDX documentation](https://mdxjs.com/).
### Slides
Slides are separated with `---`.
To customize specific MDX functionality in Spectacle Boilerplate MDX, including what characters are used to demarcate slide breaks, refer to the `loader.js` file. We don't recommend altering this functionality unless necessary.
## Getting Started
After downloading the boilerplate, your first order of business is to open a terminal and run
```bash
yarn
```
or
```bash
npm install
```
Next, run
```bash
rm -R .git
```
to remove the existing version control.
Then, to start up the local server, run
```bash
yarn start
```
or
```bash
npm start
```
Open a browser and hit [http://localhost:3000](http://localhost:3000), and you're ready to roll. Modify `index.mdx` to see changes, but the best part about MDX is that you can create your own React components and import them into the `index.mdx` file to seamlessly integrate with markdown!
## Build & Deployment
Building the dist version of the project is as easy as running
```bash
npm run build
```
If you want to deploy the slideshow to surge, run
```bash
npm run deploy
```