mkdocs.yml

site_name: Excav
site_url: https://excav.dev
repo_url: https://github.com/sn3d/excav
edit_uri: edit/main/docs/
theme:
  name: material
  custom_dir: docs/overrides
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - navigation.top
    - navigation.instant
    - navigation.indexes
    - navigation.sections
    - content.code.copy
  font:
    text: 'Work Sans'
  palette: 
    primary: white
    accent: red

extra_css:
  - stylesheets/extra.css

extra:
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  analytics:
    provider: google
    property: G-8XTJKD7Z6H

plugins:
  - search
  - tags
  - social:
      cards_color:
        fill: "#FFFFFF" 
        text: "#000000"
      cards_font: 'Work Sans'

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: true
  - 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.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Introduction: intro.md
  - Installation: installation.md
  - Quick start: quick_start.md

  - Concepts:
    - concepts/index.md
    - Inventory: concepts/inventory.md
    - Patch: concepts/patch.md

  - Tasks:
    - tasks/index.md
    - Append: tasks/append.md
    - File: tasks/file.md
    - Put: tasks/put.md
    - Remove: tasks/remove.md
    - Replace: tasks/replace.md
    - Script: tasks/script.md