mkdocs.yml

site_name: Biscuit
site_description: "A lightweight, fast, and extensible code editor with a wide range of language support"
site_url: "https://tomlin7.github.io/biscuit"
repo_url: "https://github.com/tomlin7/biscuit"
repo_name: "tomlin7/biscuit"
copyright: Copyright © 2024 Billy

docs_dir: docs

theme:
  name: "material"
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: orange
      accent: orange
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: orange
      accent: orange
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  features:
    - navigation.top
    - navigation.expand
    - toc.follow
    - content.code.copy
    - content.code.select

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            heading_level: 3
  - search
  - autorefs

extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/extra.js
nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: getting-started/quick-start.md
      - Installation: getting-started/installation.md
  #   - Configuration: usage/configuration.md
  - Usage:
      - CLI: usage/cli.md
  - API Reference:
      - App: api/app.md
      - CLI: api/cli.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tomlin7/biscuit

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg