QuartoDocBuilder

docblock

QuartoDocBuilder

A Julia package for building documentation websites using Quarto, inspired by R’s pkgdown package.

Features

• Generate documentation from Julia docstrings
• Organized reference pages with grouping
• Multiple navbar sections with dropdowns
• Articles/vignettes support
• Changelog generation from NEWS.md
• GitHub Actions integration
• Customizable themes and navigation
• Optional default styles (applied when no theme is specified)

Quick Start

using MyPackage
using QuartoDocBuilder

# Simple usage (uses default styles)
config = QuartoConfig(
    module_name = MyPackage,
    repo = "user/MyPackage.jl"
)
quarto_build_site(config)

# With Quarto theme (default styles NOT applied)
config = QuartoConfig(
    module_name = MyPackage,
    repo = "user/MyPackage.jl",
    theme = ThemeConfig(bootswatch="flatly", dark_mode=true)
)
quarto_build_site(config)

# With multiple sections
config = QuartoConfig(
    module_name = MyPackage,
    repo = "user/MyPackage.jl",
    reference = [
        ReferenceGroup(title="Core", contents=[:main_func]),
        ReferenceGroup(title="Utils", contents=[starts_with("util_")])
    ],
    sections = [
        SectionConfig(title="Tutorials", dir="tutorials", order=1),
        SectionConfig(title="Explanation", dir="explanation", order=2),
        SectionConfig(title="How-to Guides", dir="how-to", order=3)
    ]
)
quarto_build_site(config)