mkdocs.yml

site_name: Project Planner
site_description: Documentation for the Project Planner plugin for Obsidian
site_url: https://arctykdev.github.io/project-planner-docs
site_author: James Hawkins
repo_url: https://github.com/ArctykDev/obsidian-project-planner
repo_name: Obsidian Project Planner 
edit_uri: edit/main/docs/

copyright: Copyright © 2026 Project Planner and its contributors.

site_dir: site # optional but recommended
strict: false # optional but recommended
extra_css:
  - stylesheets/extra.css

theme:
  name: material
  logo: assets/project-planner-logo-mark.png
  font:
    text: ui-sans-serif
  favicon: assets/favicon.ico
  custom_dir: overrides
  features:
    - announce.dismiss
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - navigation.path
    - navigation.sections
    - navigation.instant.progress
    - search.highlight
    - search.suggest
    - search.share
    - toc.follow
    - content.code.annotate
    - content.code.copy
    - content.tooltips
  palette:
    - scheme: default
      primary: custom
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Blog:
      - Blog: blog/index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - First steps: getting-started/first-steps.md
      - FAQ: getting-started/faq.md
  - Views:
      - Dashboard view: views/dashboard-view.md
      - Grid view: views/grid-view.md
      - Board view: views/board-view.md
      - Timeline view: views/timeline-view.md
      - Dependency Graph view: views/dependency-graph-view.md
      - Task Details view: views/task-details-view.md
  - Features:
      - Data structure: features/data-structure.md
      - Markdown sync: features/markdown-sync.md
      - Task tagging: features/daily-notes-tagging.md
      - URI linking: features/uri-linking.md
  - Community:
      - Contributing: community/contributing.md
      - Share your ideas: community/sharing-ideas.md
      - Security policy: community/security.md
  - About:
      - About: about/about.md
      - Core values: about/core-values.md
      - Privacy policy: about/privacy-policy.md
  - Changelog: changelog.md

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.caret
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - footnotes
  - def_list
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption

plugins:
  - blog:
      blog_dir: blog
      blog_toc: true
      authors_file: blog/posts/.authors.yml
      authors_profiles: true
      post_url_format: "{date}/{slug}"
      post_excerpt_separator: <!-- more -->
      archive_toc: true
      pagination: true
  - search
  - minify:
      minify_html: true
  - git-revision-date-localized:
      fallback_to_build_date: true
      type: date
      locale: en
      enable_creation_date: false
  - glightbox

extra:
  status:
    new: Recently added
    deprecated: Deprecated feature
  social:
    - icon: fontawesome/brands/youtube
      link: https://youtube.com/@ArctykDev
    - icon: fontawesome/brands/discord
      link: https://discord.gg/6rgmVKK4
    - icon: simple/buymeacoffee
      link: https://www.buymeacoffee.com/ArctykDev
    - icon: fontawesome/brands/github
      link: https://github.com/ArctykDev/obsidian-project-planner
  announcement:
    # To use the announcement banner, uncomment the line below and customize the message
    # message: "🎉 <strong>New release!</strong> Check out the latest features in version X.X.X"