hier-config-cli/mkdocs.yml at main · netdevops/hier-config-cli · 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
site_name: Hier Config CLI
site_description: A command-line interface tool for network configuration analysis, remediation, and rollback
site_author: James Williams
site_url: https://netdevops.github.io/hier-config-cli/

repo_name: netdevops/hier-config-cli
repo_url: https://github.com/netdevops/hier-config-cli
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  icon:
    repo: fontawesome/brands/github

plugins:
  - search:
      lang: en

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quick Start: quick-start.md
  - User Guide:
      - Commands: commands.md
      - Supported Platforms: platforms.md
      - Output Formats: output-formats.md
  - Integration:
      - Overview: integration/index.md
      - Nornir: integration/nornir.md
      - Ansible: integration/ansible.md
      - CI/CD: integration/cicd.md
  - Development:
      - Contributing: development/contributing.md
      - Testing: development/testing.md
      - Code Quality: development/code-quality.md
  - API Reference: api-reference.md
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/netdevops/hier-config-cli
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/hier-config-cli/
  version:
    provider: mike

copyright: Copyright &copy; 2024-2026 James Williams