rstudio / pins-r

Pin, discover, and share resources
https://pins.rstudio.com
Other
316 stars 62 forks source link

Add section on Quarto to "Using web-based boards" vignette #699

Open juliasilge opened 1 year ago

juliasilge commented 1 year ago

Related to #692

To get pins released in an expedient manner, we are removing the section on Quarto originally written by @ijlyttle from the "Using web-based boards" vignette. We will add this back in after quarto-dev/quarto-cli#3766 is resolved.

### Quarto

Using Quarto, you can [publish](https://quarto.org/docs/publishing/) to GitHub Pages, Quarto Pub, and Netlify, among others.

Let's say you set up a board using a directory called `"pins-board"`; of course, you may wish to use a different name.
Here's how to set up your Quarto project:

1. In your code, create a `board_folder("pins-board")` in the root directory:
  - Write to the board using `pin_write()`.
  - At the end, call `write_board_manifest()`.

2. Add the board folder as a [Quarto site-resource](https://quarto.org/docs/websites/website-tools.html#site-resources):

  - At the top level of your `_quarto.yml` file:

    ```yml
    resources:
      - pins-board

Here's an example of a Quarto repository and its published website.