poma/mkdocs.yml at main · friedsilicon/poma · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
site_name: PoMa Documentation
site_description: Comprehensive YANG model validation and tooling
site_author: PoMa Team
site_url: https://friedsilicon.github.io/poma

# Repository
repo_name: friedsilicon/poma
repo_url: https://github.com/friedsilicon/poma

# Configuration
theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy

# Extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true

# Navigation
nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: getting-started/quick-start.md
    - Installation: getting-started/installation.md
    - Troubleshooting: getting-started/troubleshooting.md
  - User Guide:
    - Validation Workflows: user-guide/validation.md
    - Models Overview: user-guide/models-overview.md
    - Scripts Reference: user-guide/scripts-reference.md
  - Models:
    - Overview: models/index.md
    - Nokia Models: models/nokia.md
    - OpenConfig Models: models/openconfig.md
    - BGP State Comparison: models/bgp-state-comparison.md
    - BGP Config Comparison: models/bgp-config-comparison.md
    - Assessment: models/assessment.md
  - Examples:
    - NETCONF XML Samples: examples/netconf-xml-samples.md
    - Model Incompatibilities: examples/model-incompatibilities.md
  - Development:
    - Contributing: development/contributing.md
    - Project Structure: development/project-structure.md
    - Adding Models: development/adding-models.md
    - Performance Optimization: development/performance-optimization.md
  - Reference:
    - YANG Tools: reference/yang-tools.md
    - Command Reference: reference/command-reference.md

# Plugins
plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true