webpro / reveal-md

reveal.js on steroids! Get beautiful reveal.js presentations from any Markdown file
MIT License
3.71k stars 416 forks source link

Update documentation about location of reveal.json #455

Closed pixelastic closed 1 year ago

pixelastic commented 1 year ago

image

The documentation mentions that the reveal.json file should be located at the root directory of the Markdown files. It doesn't appear to be the case, and it seems to pick it up from the project root instead.

This PR updates the documentation accordingly.


For context, I have my slides in ./slides/index.md, and run reveal-md (installed locally) through yarn run reveal-md ./slides/index.md --watch.

webpro commented 1 year ago

Fair enough, thanks!