API Reference

DocumenterShiki{T}(;
    theme="github-light",
    dark_theme="github-dark",
    languages=["julia", "javascript", "python", "bash", "json", "yaml", "toml"],
    cdn_url="https://esm.sh",
    assets=String[],
    logo=Logo(),
    makedocs_kwargs=Dict{Symbol,Any}(),
    canonical_url=make_canonical(T),
    devbranch=nothing,
    edit_link=:commit,
    make_jl=default_file("documenter_shiki", "make.jlt"),
    index_md=default_file("documenter_shiki", "index.md"),
    shiki_highlighter_jl=default_file("documenter_shiki", "ShikiHighlighter.jlt"),
)

PkgTemplates plugin for generating package templates with DocumenterShiki.

Documentation deployment depends on T, where T is some supported CI plugin, or NoDeploy to only support local documentation builds.

Supported Type Parameters

• GitHubActions: Deploys documentation to GitHub Pages with GitHubActions
• TravisCI: Deploys documentation to GitHub Pages with TravisCI
• GitLabCI: Deploys documentation to GitLab Pages with GitLabCI
• NoDeploy (default): Does not set up documentation deployment

Keyword Arguments (Shiki-specific)

• theme::String: Light mode theme (default: "github-light")
• dark_theme::String: Dark mode theme (default: "github-dark")
• languages::Vector{String}: Supported languages (default: julia, javascript, python, bash, json, yaml, toml)
• cdn_url::String: CDN URL for Shiki (default: "https://esm.sh")

Keyword Arguments (Documenter-inherited)

• assets::Vector{String}: Additional asset files
• logo::Logo: Logo configuration
• makedocs_kwargs::Dict{Symbol, Any}: Additional makedocs() arguments
• canonical_url::Union{Function, Nothing}: Canonical URL function or string
• devbranch::Union{String, Nothing}: Development branch name
• edit_link::Union{String, Symbol, Nothing}: Edit link configuration

Template Files

• make_jl::String: Path to make.jl template
• index_md::String: Path to index.md template
• shiki_highlighter_jl::String: Path to ShikiHighlighter.jl template

Examples

# Local documentation only
DocumenterShiki()

# With GitHub Actions deployment
DocumenterShiki{GitHubActions}(
    theme="github-light",
    dark_theme="github-dark"
)

Logo(; light=nothing, dark=nothing)

Logo configuration for documentation.

Keyword Arguments

• light::Union{String, Nothing}: Path to a logo file for the light (default) theme.
• dark::Union{String, Nothing}: Path to a logo file for the dark theme.

Source: https://github.com/JuliaCI/PkgTemplates.jl/blob/v0.7.56/src/plugins/documenter.jl#L9-L21