Skip to content

Commit

Permalink
Replace bookdown with quarto instructions (#231)
Browse files Browse the repository at this point in the history
Co-authored-by: Heather Turner <ht@heatherturner.net>
  • Loading branch information
ccamara and hturner authored Dec 11, 2024
1 parent 71bb411 commit 8ffa7c6
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ A list of existing resources on R core development that we can use for reference

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

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.
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.

### With write access

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

- 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/> .

If you want to render the guide locally, you need to install `bookdown`. Then use
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:

```bookdown::render_book('index.Rmd', 'bookdown::gitbook')```
```quarto preview```

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.
to preview changes in real time, or:

```quarto render```

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`.

If you are using RStudio, VS Code or Positron, you can use the Preview button (VS Code/Positron) or Render button (RStudio) instead.

## Code of Conduct

Expand Down

0 comments on commit 8ffa7c6

Please sign in to comment.