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.

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

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

Open
juliasilge opened this issue Jan 20, 2023 · 0 comments
Open

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

juliasilge opened this issue Jan 20, 2023 · 0 comments
Labels
feature a feature request or enhancement

Comments

@juliasilge
Copy link
Member

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

  - You may wish to add `/pins-board/` to your project's `.gitignore` file.

Here's an example of a [Quarto repository](https://github.com/ijlyttle/quarto-pins) and its [published website](https://ijlyttle.github.io/quarto-pins/).
@juliasilge juliasilge added the feature a feature request or enhancement label May 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement
Projects
None yet
Development

No branches or pull requests

1 participant