mkdocs.yml

site_name: HF Hub Prompts
site_description: A Python library for sharing and downloading prompts on the Hugging Face Hub
site_url: https://moritzlaurer.github.io/hf_hub_prompts/
repo_url: https://github.com/MoritzLaurer/hf_hub_prompts
repo_name: moritzlaurer/hf_hub_prompts

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
    - navigation.footer
    - navigation.instant
    - navigation.tracking
    - toc.follow
    - header.autohide
  
  # Update color scheme to match HF style
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode - matches HF's dark theme
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/MoritzLaurer/hf_hub_prompts
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/hf-hub-prompts/

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_object_full_path: false
            heading_level: 2
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_section_style: table

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html

nav:
  - Home: 
    - Overview: index.md
    - HF Hub Repo Types: repo_types_examples.md
    - Standard Prompt Format: standard_prompt_format.md
    - Tools: tools.md
    - Agents: agents.md
  - API Reference:
    - Downloading prompts: reference/hub_api.md
    - Prompt templates: reference/prompt_templates.md
    - Populated prompt: reference/populated_prompt.md