QuartoConfig

docblock

Main configuration struct for QuartoDocBuilder.

Fields

Basic

• module_name::Union{Module, Nothing}: The module to document
• output_dir::String: Output directory for rendered site (default: “site”)
• repo::String: GitHub repository in “user/repo” format ## Execution
• freeze::String: Quarto freeze option (default: “auto”)
• cache::String: Quarto cache option (default: “true”)
• warning::String: Show warnings (default: “false”) ## Reference
• reference::Vector{ReferenceGroup}: Reference page organization ## Sections (Multiple Navbar Dropdowns)
• sections::Vector{SectionConfig}: Multiple navbar sections with dropdowns
• get_started::String: Path to “Get Started” page (shown prominently in navbar) ## News
• news::Bool: Generate news page from NEWS.md (default: true)
• news_file::String: Path to news file (default: “NEWS.md”) ## Navigation
• navbar_left::Vector{NavbarItem}: Custom left navbar items
• navbar_right::Vector{NavbarItem}: Custom right navbar items ## Comments
• comments::Bool: Enable Giscus comments (default: true)
• giscus_repo::String: Repository for Giscus (defaults to repo) ## Appearance
• theme::ThemeConfig: Theme configuration ## Footer
• footer::FooterConfig: Footer configuration

Example (with multiple sections)

config = QuartoConfig(
    module_name = MyPackage,
    repo = "user/MyPackage.jl",
    reference = [
        ReferenceGroup(title="Core", contents=[:main_func, :helper_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)
    ],
    theme = ThemeConfig(bootswatch="cosmo", dark_mode=true)
)