mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

site_name: wiki-tui
site_url: https://builditluc.github.io/wiki-tui
site_author: Builditluc

repo_name: builditluc/wiki-tui
repo_url: https://github.com/builditluc/wiki-tui

theme:
  name: material
  custom_dir: docs/.overrides
  icon:
    logo: material/console
    repo: fontawesome/brands/github
  favicon: assets/images/logo.png
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.sections
    - navigation.indexes
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - First Startup: getting-started/first-startup.md
    - Using the CLI: getting-started/using-cli.md
    - Overview of Keybindings: getting-started/overview-keybindings.md
    - License: getting-started/license.md

    - Changelog:
      - changelog/index.md
      - How to upgrade: changelog/upgrade.md

    - Contributing: 
      - contributing/index.md
      - Creating a Bug and Crash report: contributing/bug-report.md
      - Requesting / Implementing a feature: contributing/feature-request.md
      - Modifying the project: contributing/developing.md
      - Maintainers Guides: contributing/maintainers.md

  - Configuration:
    - configuration/index.md
    - Api Settings: configuration/api.md
    - Changing the Theme: configuration/theme.md
    - Configure the Logging: configuration/logging.md
    - Features: configuration/features.md
    - Keybindings: configuration/keybindings.md
    - Table of Contents: configuration/toc.md

edit_uri: edit/main/docs/

markdown_extensions:
  - meta
  - attr_list
  - admonition
  - tables
  - md_in_html
  - def_list
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.keys
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

plugins:
  - tags
  - social
  - git-revision-date-localized:
      enable_creation_date: true

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/builditluc/

copyright: Copyright © 2021 - 2023 Builditluc