mkdocs.yml

# mkdocs.yml
# This comment indicates the path of the file relative to the project root.

# MkDocs configuration for the CodeBrief project documentation.
# yaml-language-server: $schema=https://json.schemastore.org/mkdocs-material.json


# Project information
site_name: CodeBrief
site_url: "https://Shorzinator.github.io/CodeBrief"
site_author: Shourya Maheshwari
site_description: "A powerful CLI toolkit to generate comprehensive project context for Large Language Models (LLMs)"

# Repository
repo_url: https://github.com/Shorzinator/CodeBrief
repo_name: Shorzinator/CodeBrief
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2024 Shourya Maheshwari

# Theme Configuration
theme:
  name: material
  language: en
  features:
    - announce.dismiss # Dismissible announcement bar
    - content.action.edit # Edit button
    - content.action.view # View source button
    - content.code.annotate # Code annotation feature
    - content.code.copy # Copy button for code blocks
    - content.code.select # Select code blocks
    - content.tabs.link # Link content tabs
    - content.tooltips # Tooltips
    - header.autohide # Auto-hide header on scroll
    - navigation.expand # Expand navigation by default
    - navigation.footer # Footer navigation
    - navigation.indexes # Navigation index pages
    - navigation.instant # Instant loading
    - navigation.instant.prefetch # Prefetch pages
    - navigation.instant.progress # Loading progress indicator
    - navigation.prune # Prune navigation
    - navigation.sections # Group pages into sections
    - navigation.tabs # Use tabs for top-level navigation
    - navigation.tabs.sticky # Sticky navigation tabs
    - navigation.top # Back-to-top button
    - navigation.tracking # Track navigation in URL
    - search.highlight # Highlight search terms
    - search.share # Share search results
    - search.suggest # Search suggestions
    - toc.follow # Follow table of contents
    - toc.integrate # Integrate table of contents into navigation
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: grey
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
  # logo: assets/logo.png # Add logo if available
  # favicon: assets/favicon.ico # Add favicon if available

# Extensions
markdown_extensions:
  - abbr # Abbreviations
  - admonition # Admonition blocks
  - attr_list # Attribute lists
  - def_list # Definition lists
  - footnotes # Footnotes
  - md_in_html # Markdown in HTML
  - toc:
      permalink: true
      title: On this page
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret # Superscript and underline
  - pymdownx.details # Collapsible sections
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys # Keyboard keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: Shorzinator
      repo: CodeBrief
  - pymdownx.mark # Highlight text
  - pymdownx.smartsymbols # Smart symbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde # Strikethrough

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_submodules: true
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            show_object_full_path: false
            show_category_heading: true
            show_if_no_docstring: false
            heading_level: 2
            members_order: source
            group_by_category: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
  - minify:
      minify_html: true
      minify_css: true
      minify_js: true
      htmlmin_opts:
        remove_comments: true
        remove_empty_space: true
        remove_optional_attribute_quotes: false
        reduce_boolean_attributes: true
        keep_pre: true
  - git-revision-date-localized:
      enable_creation_date: true
      type: date

# Customization
extra:
  # version:
  #   provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Shorzinator/CodeBrief
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/codebrief/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/Shorzinator
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  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.

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - CLI Commands: user-guide/cli-commands.md
    - CLI Usage: user-guide/cli-usage.md
    - Configuration: user-guide/configuration.md
    - Dependency Analysis: user-guide/dependency-analysis.md
  - Tutorials:
    - Basic Usage: tutorials/basic-usage.md
    - Advanced Workflows: tutorials/advanced-workflows.md
    - LLM Integration: tutorials/llm-integration.md
    - CI/CD Integration: tutorials/cicd-integration.md
  - API Reference:
    - Main CLI: reference/main.md
    - Tree Generator: reference/tree_generator.md
    - Flattener: reference/flattener.md
    - Config Manager: reference/config_manager.md
    - Tools:
      - Dependency Lister: reference/tools/dependency_lister.md
      - Bundler: reference/tools/bundler.md
      - Git Provider: reference/tools/git_provider.md
  - Examples:
    - Python Projects: examples/python-projects.md
    - Bundle Workflows: examples/bundle-workflows.md
    - Git Workflows: examples/git-workflows.md
  - Development:
    - Contributing: development/contributing.md
    - Infrastructure: development/infrastructure.md
  - Community: community.md
  - Help:
    - FAQ: help/faq.md
    - Troubleshooting: help/troubleshooting.md
    - Support: help/support.md

# Custom CSS and JavaScript
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Where your Markdown documentation files are located
docs_dir: docs

# Where the documentation site will be built
site_dir: site

# Development server settings
dev_addr: 127.0.0.1:8000

# Build settings
strict: false