Skip to content

Commit

Permalink
docs: Quarto instructions improved
Browse files Browse the repository at this point in the history
  • Loading branch information
maehr committed May 7, 2024
1 parent 1229e3c commit f8560fb
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit f8560fb

Please sign in to comment.