Skip to content

Commit 8ffa7c6

Browse files
ccamarahturner
andauthored
Replace bookdown with quarto instructions (#231)
Co-authored-by: Heather Turner <[email protected]>
1 parent 71bb411 commit 8ffa7c6

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A list of existing resources on R core development that we can use for reference
1717

1818
Corrections, suggestions and general improvements are welcome as [issue submissions](issues/new).
1919

20-
You can also suggest changes by editing the .Rmd files that are at the root of this repository and submitting a pull request. Please target your pull requests to the `main` branch.
20+
You can also suggest changes by editing the `.qmd` files that are in the `chapters/` folder at the root of this repository and submitting a pull request. Please target your pull requests to the `main` branch.
2121

2222
### With write access
2323

@@ -34,11 +34,17 @@ Deployment is done via GitHub Actions, as specified in the [publish.yml](https:/
3434

3535
- whenever there's a push to main, the book is built and its content is put on the `gh-pages` branch, triggering the github-pages bot to deploy to <https://contributor.r-project.org/rdevguide/> .
3636

37-
If you want to render the guide locally, you need to install `bookdown`. Then use
37+
If you want to render the guide locally, you need to download and install the Quarto CLI (command line interface) as documented on the [Quarto website](https://quarto.org/docs/get-started/). Then, from the command line (not the R console), run:
3838

39-
```bookdown::render_book('index.Rmd', 'bookdown::gitbook')```
39+
```quarto preview```
4040

41-
and the book will be generated in the `docs` folder. You can open the guide on the command line via `open docs/index.html`. To preview the PDF or EPUB versions locally, replace `'bookdown::gitbook'` with `'bookdown::pdf_book'` or `'bookdown::epub_book`' as appropriate.
41+
to preview changes in real time, or:
42+
43+
```quarto render```
44+
45+
to generate the book in the `_book/` folder. This will also generate the PDF and ePub versions of the book, so takes a little longer. You can open the HTML version of the guide from the command line via `open _book/index.html`.
46+
47+
If you are using RStudio, VS Code or Positron, you can use the Preview button (VS Code/Positron) or Render button (RStudio) instead.
4248

4349
## Code of Conduct
4450

0 commit comments

Comments
 (0)