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.
✘ If I create ./slides/reveal.json, it is not being used
✔ If I create ./reveal.json (right next to package.json), it is correctly being used.
The documentation mentions that the
reveal.json
file should be locatedat 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 runreveal-md
(installed locally) throughyarn run reveal-md ./slides/index.md --watch
../slides/reveal.json
, it is not being used./reveal.json
(right next topackage.json
), it is correctly being used.