Interface DjockeyConfig

interface DjockeyConfig {
    default_markdown_variant: MarkdownVariant;
    features?: {
        syntax_highlighting?: {
            default_code_block_language: string;
            default_inline_language: string;
            theme_dark: string;
            theme_light: string;
        };
    };
    gfm: {
        ignore_static: string[];
    };
    html: {
        extra_static_dirs?: {
            exclude_patterns?: string[];
            path: string;
            patterns?: string[];
            prefix?: string;
        }[];
        footer_text: string;
        ignore_css?: string[];
        ignore_static: string[];
    };
    input_dir: string;
    link_mappings?: LinkMappingConfig[];
    num_passes: number;
    output_dir: Record<DjockeyOutputFormat, string>;
    plugins: string[];
    project_info?: {
        description?: string;
        github_url?: string;
        social_image?: string;
        version?: string;
    };
    site_name: string;
    url_root?: string;
}

Hierarchy (view full)

Properties

default_markdown_variant features? gfm html input_dir link_mappings? num_passes output_dir plugins project_info? site_name url_root?

Properties

default_markdown_variant

default_markdown_variant: MarkdownVariant

Optionalfeatures

features?: {
    syntax_highlighting?: {
        default_code_block_language: string;
        default_inline_language: string;
        theme_dark: string;
        theme_light: string;
    };
}

gfm

gfm: {
    ignore_static: string[];
}

html

html: {
    extra_static_dirs?: {
        exclude_patterns?: string[];
        path: string;
        patterns?: string[];
        prefix?: string;
    }[];
    footer_text: string;
    ignore_css?: string[];
    ignore_static: string[];
}

input_dir

input_dir: string

Optionallink_mappings

link_mappings?: LinkMappingConfig[]

num_passes

num_passes: number

output_dir

output_dir: Record<DjockeyOutputFormat, string>

plugins

plugins: string[]

Optionalproject_info

project_info?: {
    description?: string;
    github_url?: string;
    social_image?: string;
    version?: string;
}

site_name

site_name: string

Optionalurl_root

url_root?: string

Settings

Member Visibility

On This Page

Properties