quarto.org
Source code and documentation for the Quarto documentation website, built with Quarto itself.
What is quarto.org?
quarto-web is the source code and content repository for the official Quarto documentation website, hosted at quarto.org and its prerelease counterpart. It serves as the primary learning resource for the Quarto scientific and technical publishing system and is itself built using Quarto to demonstrate the tool's capabilities. The project uses Quarto's features like frozen computation states and profiles to manage a dual-site system from a single codebase.
Quarto users and contributors who need to understand, use, or contribute to the official Quarto documentation. This includes technical writers, developers, and researchers who want to learn about Quarto's features or update its documentation.
Developers choose this project as a reference implementation for building complex, reproducible documentation sites with Quarto, showcasing best practices like automated reference generation, managed computational environments, and a dual-profile system for managing stable and prerelease documentation from one source.
Overview
Quarto website
Use Cases
Best For
- Building a documentation website that demonstrates the capabilities of the Quarto publishing system itself.
- Managing a documentation site with reproducible computational examples using R (renv) and Python (pipenv) environments.
- Implementing a dual-site architecture (e.g., stable and prerelease versions) from a single Quarto codebase using profiles.
- Creating documentation that avoids re-running computational engines during full site renders by using Quarto's freeze feature.
- Automatically generating reference documentation tables from a CLI schema.
- Contributing to or understanding the official Quarto documentation workflow and infrastructure.
Not Ideal For
- Teams wanting a simple, single-site documentation setup without advanced Quarto features like profiles or freeze
- Projects that require dynamic, on-the-fly computation during site builds, as this project uses frozen states to avoid running engines
- Small documentation projects that don't need reproducible R and Python environments, given the heavy setup with renv and pipenv
- Developers seeking a generic static site generator example, as it's tightly coupled to Quarto's ecosystem and specific use cases
Pros & Cons
Pros
Reference tables for Quarto options are auto-generated from the CLI schema using a custom script, ensuring accuracy and reducing manual maintenance, as detailed in the README's reference section.
Uses renv for R and pipenv for Python to ensure reproducible execution of code examples, with clear setup steps and dependency tracking in DESCRIPTION and Pipfile files.
Implements Quarto's freeze feature to avoid running engines during full site renders, enabling consistent builds and faster rendering, as explained in the rendering workflow.
Manages two distinct sites (stable and prerelease) from a single codebase using Quarto's profiles, demonstrated with phase and site profiles for flexible branding and configuration.
Cons
Requires installing and managing renv and pipenv with specific commands for R and Python, which can be a barrier for casual contributors, as noted in the detailed environment setup instructions.
Relies on advanced Quarto features like freeze and profiles, making the project less adaptable to other static site generators and limiting its utility as a general documentation example.
The use of pipenv may lead to python version conflicts, as mentioned in the README where pipenv might ask for a newer version if the current one doesn't match Pipfile.lock, complicating local development.
Frequently Asked Questions
Related Projects
Documentation website from Jupyter Notebookskimpy is a light weight tool that provides summary statistics about variables in data frames within the console.
R-ManualsA re-styled version of the R manuals
Quarto tip a dayQuarto Tip a Day is a website and blog project created to share daily Quarto tips during the month leading up to the rstudio::conf(2022) keynote presentation. It serves as a practical resource for Quarto users looking to improve their skills and learn new techniques through bite-sized daily insights. ## Key Features - **Daily Tips** — One Quarto tip published each day for 30 consecutive days - **Conference Countdown** — Timed to build anticipation for the rstudio::conf(2022) keynote on Quarto - **Practical Focus** — Actionable advice and techniques for working with Quarto - **Educational Format** — Bite-sized learning approach makes complex topics more accessible ## Philosophy The project follows a playful "tip a day" philosophy inspired by the saying "An apple a day keeps the doctor away," aiming to make Quarto documentation more engaging and digestible through daily micro-learning.
Program Evaluation for Public Service (course)📊 🌐 🧑🏫 Website for graduate-level course on program evaluation and causal inference using R, built with Quarto
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.