-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update Readme with rendering instructions
- Loading branch information
Showing
1 changed file
with
7 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
A utility repository to build a quarto book website for the BMM Developer Notes for the bmm package: https://github.com/venpopov/bmm | ||
|
||
The contents of the `_book` directory contain the rendered website, and they are automatically pushed via Github Action to the gh-pages branch of `bmm` | ||
The contents of the `_book` directory contain the rendered website, and they are automatically pushed via Github Action to the gh-pages branch of `bmm`. | ||
|
||
## How to makes changes | ||
|
||
1. Make the changes to the .qmd files | ||
2. Run `quarto render` from the terminal to render the book | ||
3. Commit and push the changes to the `master` branch |