mkdocs.yml

site_name: PlanExe Documentation
site_description: From a single goal statement to a full strategic plan. Free and open source.
site_url: https://docs.planexe.org
repo_url: https://github.com/PlanExeOrg/PlanExe
repo_name: PlanExeOrg/PlanExe
edit_uri: edit/main/docs/

nav:
  - Getting started:
    - Welcome: index.md
    - Start here: start_here.md
    - Getting started: getting_started.md
    - Prompt writing guide: prompt_writing_guide.md
    - Plan output anatomy: plan_output_anatomy.md
    - Costs and models: costs_and_models.md
    - FAQ: faq.md
    - Statistics: statistics.md
  - MCP:
    - Welcome: mcp/mcp_welcome.md
    - MCP setup: mcp/mcp_setup.md
    - MCP registry publishing: mcp/mcp_registry.md
    - MCP Inspector: mcp/inspector.md
    - Claude: mcp/claude.md
    - Cursor: mcp/cursor.md
    - Codex: mcp/codex.md
    - Antigravity: mcp/antigravity.md
    - Windsurf: mcp/windsurf.md
    - LM Studio: mcp/lm_studio.md
    - MCP details: mcp/mcp_details.md
    - MCP troubleshooting: mcp/mcp_troubleshooting.md
    - PlanExe MCP interface: mcp/planexe_mcp_interface.md
  - Development:
    - Developer plan: plan.md
    - Docker: docker.md
    - Developer install: install_developer.md
    - OAuth setup: oauth.md
    - LLM config: llm_config.md
    - Token counting: token_counting.md
    - Components:
      - open_dir_server: developer/open_dir_server.md
      - worker_plan: developer/worker_plan.md
      - frontend_single_user: developer/frontend_single_user.md
      - database_postgres: developer/database_postgres.md
      - worker_plan_database: developer/worker_plan_database.md
      - frontend_multi_user: developer/frontend_multi_user.md
      - mcp_local: developer/mcp_local.md
      - mcp_cloud: developer/mcp_cloud.md
    - AI providers:
      - OpenRouter: ai_providers/openrouter.md
      - Ollama: ai_providers/ollama.md
      - LM Studio: ai_providers/lm_studio.md
      - Mistral: ai_providers/mistral.md
    - Status: status.md
    - Railway: railway.md
    - Deployment and hosting: deployment_hosting.md
    - Docs style guide: docs_style_guide.md
    - Troubleshooting:
      - Stuck pipeline: troubleshooting_stuck_pipeline.md

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.png
  palette:
    # Light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - content.code.annotate
    - content.code.copy

plugins:
  - search
  - social:
      cards_layout_options:
        background_color: "#1f2a37"
        description: "From a single goal statement to a full strategic plan."

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html

extra_javascript:
  - assets/javascripts/copy-all.js

extra_css:
  - assets/stylesheets/copy-all.css
  - assets/stylesheets/nav-status.css

extra:
  analytics:
    provider: google
    property: G-2F6NE7JWTR
  homepage: https://planexe.org