Template Website: An opinionated setup to building and developing Quarto-based websites

This is a template for creating a new repository for building Quarto-based websites. Use this template to quickly get started with making a website as well as having infrastructure configuration to make developing and building the website easier.

Features

• Uses Quarto Markdown for the website content, allowing for easy integration of code, text, and figures.
• Includes a justfile for managing common tasks like building the website and running checks.
• Uses typos to check for common spelling mistakes.
• Uses Commitizen to check commit messages and automatically create the changelog.
• Automated Git tagging and GitHub releases with commitizen that are based on messages following Conventional Commits.
• Uses a CC-BY-4.0 license for the website content.
• Run checks with pre-commit hooks to ensure consistent formatting and style across the project. It includes checks for credentials, typos, and file formatting.
• Optionally uses the seedcase-theme Quarto extension for a standard appearance across websites.
• Includes GitHub Actions for continuous integration, testing, and delivery for running checks, formatting, releasing, and building the website.
• Uses Netlify for hosting the website.
• Includes an EditorConfig file to ensure consistent formatting across different editors.
• High level, system and program management with uv.
• GitHub workflows for automatically adding Pull Requests and Issues to a project board.
• Pull Request template for easy creation of new Pull Requests.
• VS Code settings commonly used by contributors working in VS Code.
• .zenodo.json file for citation information that provides Zenodo with the necessary metadata to create a DOI for the website.

Want to contribute?

We would love your feedback or contributions! Head over to our GitHub repository to share your ideas or contribute code. Your input makes us better!