mkdocs_base.yml

site_name: Project Mu
repo_url: https://github.com/microsoft/mu
copyright: Copyright (c) Microsoft.  All rights reserved
site_description: "Project Mu Documentation"
site_url: 'https://microsoft.github.io/mu/'
plugins:
    - search
    - macros

extra_javascript:
  - https://unpkg.com/mermaid@8.7.0/dist/mermaid.min.js

theme:
  name: 'material'
  custom_dir: 'theme'
  logo: 'img/mu.png'
  palette:
    primary: 'indigo'
    accent: 'indigo'

#
# Material theme adds additional capabilities
#
markdown_extensions:
  - admonition
  - codehilite
  - meta
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.tabbed
  - toc:
      permalink: true

nav:
  - Home: 'index.md'
  - What and Why:
    - Overview: 'WhatAndWhy/overview.md'
    - Dependencies and Layout: 'WhatAndWhy/layout.md'
    - Features: 'WhatAndWhy/features.md'
    - Rust: 'WhatAndWhy/rust.md'
    - Enhanced Memory Protection: 'WhatAndWhy/enhancedmemoryprotection.md'
    - Security: 'WhatAndWhy/security.md'
  - Where:
    - Project Resources: 'Where/project_resources.md'
    - External Resources: 'Where/external_resources.md'
  - How:
    - Release Process: 'How/release_process.md'
    - Integration Checklist: 'How/integration_checklist.md'
    - Contributing: 'How/contributing.md'
    - Using: 'How/using_project_mu.md'
  - Developing Docs:
    - Overview: "DeveloperDocs/developer_docs.md"
    - How To Build: "DeveloperDocs/build_community_docs.md"
    - Sample Syntax: "DeveloperDocs/doc_sample_test.md"
    - Doc Framework Attribution: "DeveloperDocs/attribution.md"
    - Documentation Requirements: "DeveloperDocs/requirements.md"
  - Developing Code:
    - Overview: "CodeDevelopment/overview.md"
    - Tools and Prerequisite: "CodeDevelopment/prerequisites.md"
    - Compiling: "CodeDevelopment/compile.md"
    - Testing: "CodeDevelopment/test.md"
    - Code Requirements: "CodeDevelopment/requirements.md"
    - Rust Compiling and Testing: "CodeDevelopment/rust_build.md"
    - Rust Documentation Conventions: "CodeDevelopment/rust_documentation_conventions.md"
  - FAQ: 'faq.md'
  - License: 'license.md'
  #AUTOGENERATED CONTENT WILL BE ADDED HERE