mkdocs.yml

site_name: "Woke - Detect non-inclusive language in your source code"

site_author: Caitlin Elfring
site_description: Detect non-inclusive language in your source code.
repo_url: https://github.com/get-woke/woke
repo_name: get-woke/woke
edit_uri: edit/main/docs/
copyright: Copyright © 2020 - 2021 Caitlin Elfring

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/default-monochrome.svg
  favicon: assets/favicon.ico
  palette:
    scheme: woke
    primary: black
  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
nav:
  - Introduction: index.md
  - Getting Started:
    - Installation: installation.md
  - User Guide:
    - Usage: usage.md
    - Rules: rules.md
    - Ignoring: ignore.md
  - More Info:
      About: about.md
      Tools: tools.md

markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - macros:
      include_dir: docs/snippets
  - search
  - git-revision-date

extra_css:
  - css/extra.css
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/get-woke
      name: GitHub
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/getwoke/woke/
      name: Docker
  analytics:
    provider: google
    property: G-7X5Z78ZRDB
    # property: UA-XXXXXXXX-X