Configuration reference

# djockey.yaml
site_name: "Your name here"
url_root: "https://your-docs-site-here"
project_info:
  version: 0.0.1
  github_url: https://github.com/your/project
  description: "Site description for social media"
  image: "Path to image inside your docs directory for social media"
input_dir: "path to your docs"
output_dir:
  html: "path to your HTML output"
  gfm: "path to your GitHub Flavored Markdown output"

num_passes: 1 # only touch this if your custom plugin creates
              # new AST nodes

plugins: ["my-plugin.js"]

# Output-specific options
html:
  footer_text: "©2024 You"
  ignore_static: []
  # If you use TypeDoc, you'd want to set this to
  # path/to/typedoc/**/*.css
  ignore_css: ['some/css/you/dont/want.css']
  header_links:
    - text: "Some text"
      url: "https://a/full/url"
  extra_static_dirs:
    - path: "../node_modules/some_library"
      exclude_patterns: ['**/*.ts'] # optional
      patterns: # optional; default is '**/*'
        - '**/*.css'

gfm:
  ignore_static: ["**/*.html", "**/*.css", "**/*.js"]

features:
  syntax_highlighting:
    theme_light: vitesse-light
    theme_dark: vitesse-dark
    # Set default languages for syntax highlighting to save
    # yourself typing
    default_code_block_language: typescript
    default_inline_language: text