This is the repo for the Positron website at https://positron.posit.co/.
This site is built with Quarto and the Posit product documentation theme, and these educational materials are released under a Creative Commons Attribution-ShareAlike 4.0 International License. Positron™ and the Positron icon™ are trademarks of Posit Software, PBC. All rights reserved.
We currently use the issue tracker for Positron. Please report documentation bugs and feature requests at https://github.com/posit-dev/positron/issues.
This project uses Vale for automated linting and compliance with the Posit style guide.
- If you are a Posit employee, you can find the "Posit Documentation Style Guide" on Confluence.
- If you are an external contributor, we as reviewers will take responsibility for compliance with the guidelines. Thank you for being willing to improve our docs!
Vale runs via GH action on PRs, but you can also run it locally before you submit a PR if you have installed Vale locally. Run vale . from the root directory of this project to lint the .qmd files used to build the site.
If you have Quarto and Chrome or Edge installed locally, you can preview the site by running one of the Debug Configurations in VS Code or Positron.
The configurations run quarto preview and then open the site in a new browser window.
- Preview Docs (Chrome): Preview the site in Chrome
- Preview Docs (Edge): Preview the site in Edge
The site will re-render as you make changes to the .qmd files.
Some .qmd files used for our site involve executable code, like the .qmd file that creates https://positron.posit.co/download. We currently use the "Local Execution with CI Rendering" option described in the Quarto docs, with the freeze execution option to make it easier for us to collaborate together across the large number of pages. For now, if you need to update a page involving computations, be sure to render that page locally and check in the files created in the _freeze directory.