mkdocs.yml

site_name: "🌈 zizmor"
# site_description: zizmor
site_url: https://woodruffw.github.io/zizmor
docs_dir: docs
site_dir: site_html
dev_addr: "127.0.0.1:9999"
repo_url: https://github.com/woodruffw/zizmor
edit_uri: edit/main/docs

nav:
  - Welcome: "index.md"
  - "installation.md"
  - "quickstart.md"
  - "usage.md"
  - "configuration.md"
  - "audits.md"
  - "development.md"
  - External links:
      - "crates.io 🔗": https://crates.io/crates/zizmor

theme:
  name: material
  palette:
    scheme: slate
  icon:
    annotation: material/arrow-right-circle
    repo: fontawesome/brands/github-alt
  features:
    - navigation.expand
    - navigation.sections
    - navigation.tracking
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  # Makes sure we render `<https://...>`-style links correctly.
  - pymdownx.magiclink:
      repo_url_shorthand: true
      normalize_issue_symbols: true
      provider: github
      user: woodruffw
      repo: zizmor
  - pymdownx.emoji
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - md_in_html
  - attr_list
  - toc:
      permalink: 🔗

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

extra_css:
  - magiclink.css