mkdocs.yml

site_name: "mkdocs-gen-files"
site_description: "MkDocs plugin to programmatically generate documentation pages during the build"
site_url: "https://oprypin.github.io/mkdocs-gen-files"
repo_url: "https://github.com/oprypin/mkdocs-gen-files"
edit_uri: blob/master/docs/
use_directory_urls: false

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

extra_css:
  - assets/style.css

watch:
  - mkdocs_gen_files

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_pages.py
  - literate-nav
  - mkdocstrings:
      handlers:
        python:
          options:
            show_root_heading: true
            show_signature_annotations: true
            show_source: false

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

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  nav:
    absolute_links: ignore

nav:
  - section-index: /mkdocs-section-index/
  - literate-nav: /mkdocs-literate-nav/
  - gen-files:
    - Manual: index.md
    - API: api.md
    - Extras: extras.md
    - Sample: sample/
  - same-dir: /mkdocs-same-dir/
  - code-validator: /mkdocs-code-validator/
  - callouts: /markdown-callouts/