From f8560fb9b3205ab21d4c09256f2ca89012d27baf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Tue, 7 May 2024 16:24:58 +0200 Subject: [PATCH] docs: Quarto instructions improved --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 3435689..f9b5975 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,8 @@ npm run prepare - [ ] run `npm run commit` to commit all changes - [ ] run `npm run changelog` and include the output in [CHANGELOG.md](CHANGELOG.md) - [ ] enable [gh-pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) +- [ ] install [Quarto](https://quarto.org/docs/installation/) +- [ ] run `quarto publish gh-pages` to publish the documentation - [ ] customize the documentation with [Quarto](https://quarto.org/docs/websites/#workflow) 3. optional tasks: @@ -114,6 +116,12 @@ Run the wizard to create a CHANGELOG.md. npm run changelog ``` +Preview the documentation. + +```bash +quarto preview +``` + ## Support This project is maintained by [@maehr](https://github.com/maehr). Please understand that we can't provide individual support via email. We also believe that help is much more valuable when it's shared publicly, so more people can benefit from it.