mkdocs.yml

# cspell: ignore pymdownx pymdown magiclink autorefs facelessuser superfences inlinehilite linenums fontawesome
site_name: Ansible Language Server
site_url: https://als.readthedocs.io/
repo_url: https://github.com/ansible/ansible-language-server
edit_uri: blob/main/docs/

theme:
  name: "material"
  logo: images/logo.svg
  favicon: images/favicon.ico
  features:
    - content.code.copy
    - content.action.edit
  palette:
    - media: "(prefers-color-scheme: light)"
      primary: teal
      accent: blue
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/ansible/ansible-language-server

nav:
  - home: README.md
  - changelog.md
  - development.md
  - settings.md
  - Contributing: contributing.md

plugins:
  - autorefs
  - search
  - exclude:
      glob:
        - changelog-fragments.d/*
  - social
  - git-revision-date-localized:
      enable_creation_date: true

markdown_extensions:
  - admonition
  - def_list
  - footnotes
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      social_url_shorthand: true
      social_url_shortener: true
      user: ansible
      repo: ansible-language-server
      normalize_issue_symbols: true
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      # reduced to keep TOC nice under Changelog page
      toc_depth: 2
      permalink: true