This example shows how to configure your documentation project to use great-docs.

After installing great-docs, simply run:

great-docs init

This will automatically:

• Copy the post-render script to scripts/post-render.py
• Copy the SCSS theme file to great-docs.scss
• Update your _quarto.yml configuration

project:
  type: website
  post-render: scripts/post-render.py

format:
  html:
    theme:
      - flatly # Works well with great-docs
      - great-docs.scss
    toc: true
    grid:
      sidebar-width: 270px
      body-width: 950px
      margin-width: 225px
      gutter-width: 1rem

website:
  title: "Your Project Name"
  navbar:
    logo: assets/logo.png # Optional

from great_docs import GreatDocs

# Initialize docs for current directory
docs = GreatDocs()

# Install docs files
docs.install()

You can customize by:

1. Editing the copied great-docs.scss file
2. Modifying the scripts/post-render.py script
3. Adding additional CSS files to your _quarto.yml