Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Quarto instructions improved #19

Merged
merged 3 commits into from
May 7, 2024
Merged

docs: Quarto instructions improved #19

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f8560fb
docs: Quarto instructions improved
maehr May 7, 2024
ab9ab79
docs: Quarto instructions improved
maehr May 7, 2024
6c3cc5c
docs: update URL
mtwente May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,10 @@ npm run prepare
- [ ] run `npm run format` to format all files
- [ ] 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/)
mtwente marked this conversation as resolved.
Show resolved Hide resolved
- [ ] run `quarto publish gh-pages` to publish the documentation
- [ ] customize the documentation with [Quarto](https://quarto.org/docs/websites/#workflow)
maehr marked this conversation as resolved.
Show resolved Hide resolved
- [ ] enable [gh-pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages) for the `gh-pages` branch

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