mkdocs.yml

# MkDocs Configuration
# For full documentation, visit: https://www.mkdocs.org

site_name: My Documentation
site_description: Documentation site powered by MkDocs and GitHub Pages
site_author: Your Name
site_url: https://softwareworkercom.github.io/docs/

# Repository information (enables "Edit on GitHub" links)
repo_name: softwareworkercom/docs
repo_url: https://github.com/softwareworkercom/docs
edit_uri: edit/main/docs/

# Theme configuration - Material Design
theme:
  name: material
  # Material Design color palette
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  # Material Design typography
  font:
    text: Roboto
    code: Roboto Mono
  # Material Design icons
  icon:
    logo: material/book-open-page-variant
    repo: fontawesome/brands/github
    admonition:
      note: material/pencil-circle
      abstract: material/clipboard-text
      info: material/information
      tip: material/fire
      success: material/check-circle
      question: material/help-circle
      warning: material/alert
      failure: material/close-circle
      danger: material/lightning-bolt
      bug: material/bug
      example: material/test-tube
      quote: material/format-quote-close
  # Material Design features
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - content.tooltips
    - toc.follow

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: getting-started/quickstart.md
      - Installation: getting-started/installation.md
      - Configuration: getting-started/configuration.md
  - User Guide:
      - Writing Content: user-guide/writing-content.md
      - Adding Pages: user-guide/adding-pages.md
      - Customization: user-guide/customization.md
  - Contributing: contributing.md

# Extensions for enhanced Markdown (Material Design compatible)
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.keys
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - def_list
  - abbr
  - footnotes
  - tables
  - toc:
      permalink: true
      permalink_title: Link to this section

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - minify:
      minify_html: true

# Extra configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/softwareworkercom
      name: GitHub Repository
  generator: false
  # Status indicators for pages
  status:
    new: Recently added
    deprecated: No longer maintained