https://github.com/stackcheats/sc-remark-reveal-mutate-plugin
A Gatsby Remark Mutate Plugin to mutate Remark content for RevealJS
https://github.com/stackcheats/sc-remark-reveal-mutate-plugin
gatsby-plugin mutate remark reveal-js stackcheats
Last synced: 3 months ago
JSON representation
A Gatsby Remark Mutate Plugin to mutate Remark content for RevealJS
- Host: GitHub
- URL: https://github.com/stackcheats/sc-remark-reveal-mutate-plugin
- Owner: stackcheats
- License: mit
- Created: 2021-06-06T07:33:55.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-19T13:42:09.000Z (about 4 years ago)
- Last Synced: 2024-04-25T13:01:00.293Z (about 1 year ago)
- Topics: gatsby-plugin, mutate, remark, reveal-js, stackcheats
- Language: JavaScript
- Homepage:
- Size: 4.88 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Remark Reveal Mutate
A Gatsby Remark plugin to mutate Markdown contents for [`reveal.js`](https://revealjs.com/).
> This implementation is inspired by [gatsby-remark-slidify](https://www.npmjs.com/package/gatsby-remark-slidify)
[:construction: Plugin Under Development]
## Installation
```sh
# not published to npm registry. hence use `npm link` to use the plugin locally
npm link
```
## Configure
Add the following plugin configuration in `gatsby-config.js` to activate the plugin
> This is a `remark` mutate plugin. Hence, the plugin should be configured as a plugin of `gatsby-transformer-remark`
```js
{
resolve: `gatsby-transformer-remark`,
options: {
plugins: [
{
resolve: 'sc-remark-reveal-mutate',
},
],
},
},
```
### Markdown Content
The following structure is used to represent the markdown contents for `reveal` slide deck.
```sh
reveal: true # frontmatter says it is reveal content
--v-- # used to annotate vertical slide
--h-- # used to annotate horizontal slide
reveal-note: # used to annotate notes
```
A sample markdown content is given below
```md
---
reveal: true
---
# StackCheats
StackCheats is a personal blog created by Athiththan.
--h--
## Now Supports Reveal!!!
StackCheats now supports `revealjs` slide decks to provide more feasible contents. Now you can move down to learn more
--v--
## Yay!!!
Now you are watching a vertical slide content
reveal-note:
This a side (speaker) note section presenting few additional points or notes relevant to this particular slide.
```
## License
[MIT](LICENSE)