mkdocs.yml

site_name: "mkdocstrings-crystal"
site_description: "Crystal language doc generator for MkDocs, via mkdocstrings"
site_url: "https://mkdocstrings.github.io/crystal"
repo_url: "https://github.com/mkdocstrings/crystal"
edit_uri: blob/master/docs/
use_directory_urls: false

theme:
  name: material
  features:
    - content.action.edit
    - navigation.expand
  icon:
    repo: fontawesome/brands/github
  palette:
    primary: teal
    accent: purple

extra_css:
  - assets/style.css

watch:
  - mkdocstrings_handlers

plugins:
  - search
  - section-index
  - mkdocstrings:
      handlers:
        python:
          options:
            filters: ["!^_[^_]", "!__new__"]
            show_signature_annotations: true
            show_source: false
            show_root_heading: true
            show_root_full_path: false

markdown_extensions:
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.magiclink
  - pymdownx.saneheaders
  - pymdownx.superfences
  - pymdownx.snippets:
      check_paths: true
      base_path:
        - !relative $config_dir
  - callouts
  - admonition
  - def_list
  - toc:
      permalink: "#"

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
  - Introduction: README.md
  - Quickstart:
    - quickstart/index.md
    - Migrate from `crystal doc`: quickstart/migrate.md
    - Managing Python dependencies: quickstart/python-dependencies.md
    - Continuous build and publishing: quickstart/ci.md
  - Configuration: configuration.md
  - Styling: styling.md
  - Extras: extras.md
  - Troubleshooting: troubleshooting.md
  - Introspection API: api.md
  - Showcase: showcase.md