forked from aristanetworks/avd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
155 lines (148 loc) · 5.62 KB
/
mkdocs.yml
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
# Project information
site_name: Arista AVD collection
site_author: Arista Ansible Team
site_description: Arista Validated Design collection's documentation
copyright: Copyright © 2019 - 2021 Arista Networks
# Repository information
repo_name: AVD on Github
repo_url: https://github.com/aristanetworks/ansible-avd
# Configuration
use_directory_urls: false
theme:
name: material
# custom_dir: ansible_collections/arista/avd/docs/_overrides
features:
- navigation.instant
- navigation.top
highlightjs: true
hljs_languages:
- yaml
- python
- shell
icon:
repo: fontawesome/brands/github
logo: fontawesome/solid/book
favicon: docs/_media/favicon.ico
font:
code: Fira Mono
language: en
include_search_page: false
search_index_only: true
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-night
name: Switch to light mode
extra_css:
- docs/stylesheets/extra.material.css
extra_javascript:
- https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
- docs/stylesheets/tables.js
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.2/highlight.min.js
- docs/stylesheets/highlight.js
plugins:
- search:
lang: en
- git-revision-date-localized:
type: date
# Deactivated due to https://github.com/tikitu/jsmin/issues/33
# Issue in progress: https://github.com/byrnereese/mkdocs-minify-plugin/issues/15
# - minify:
# minify_html: true
# minify_js: true
markdown_extensions:
- mdx_truly_sane_lists
- smarty
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
- fontawesome_markdown
- admonition
- codehilite:
guess_lang: true
- toc:
separator: "-"
# permalink: "#"
permalink: true
baselevel: 3
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.snippets:
base_path: 'ansible_collections/arista/avd/'
# TOC
docs_dir: ansible_collections/arista/avd/
nav:
- Home: README.md
- Release Notes:
- 3.x.x: docs/release-notes/3.x.x.md
- 2.x.x: docs/release-notes/2.x.x.md
- 1.1.x: docs/release-notes/1.1.x.md
- 1.0.x: docs/release-notes/1.0.x.md
- Getting Started: docs/getting-started.md
- Installation:
- Collection Installation: docs/installation/collection-installation.md
- Requirements: docs/installation/requirements.md
- How-To:
- Build your first AVD project: docs/how-to/first-project.md
- Build your first AVD & CVP project: docs/how-to/first-cvp-avd-project.md
- Use NAT to access eAPI: docs/how-to/lab-with-nat.md
- AWX & Tower Integration: docs/how-to/tower-integration.md
- Configure ZTP server with CV collection: docs/how-to/ztp.md
- VScode Container: docs/how-to/vscode-container.md
- Roles documentation:
- eos_designs:
- Overview: roles/eos_designs/README.md
- Connected Endpoints: roles/eos_designs/doc/connected-endpoints.md
- DCI & L3 Edge: roles/eos_designs/doc/l3-edge.md
- Fabric Topology: roles/eos_designs/doc/fabric-topology.md
- Fabric Variables: roles/eos_designs/doc/fabric-variables.md
- Management Settings: roles/eos_designs/doc/management-settings.md
- Network Services: roles/eos_designs/doc/network-services.md
- Node types: roles/eos_designs/doc/node-types.md
- Platform Settings: roles/eos_designs/doc/platform-settings.md
- Custom Structured Configuration: roles/eos_designs/doc/custom-structured-configuration.md
- eos_cli_config_gen: roles/eos_cli_config_gen/README.md
- cvp_configlet_upload: roles/cvp_configlet_upload/README.md
- eos_config_deploy_cvp: roles/eos_config_deploy_cvp/README.md
- eos_config_deploy_eapi: roles/eos_config_deploy_eapi/README.md
- eos_validate_state: roles/eos_validate_state/README.md
- eos_snapshot: roles/eos_snapshot/README.md
- dhcp_provisioner: roles/dhcp_provisioner/README.md
- build_output_folders: roles/build_output_folders/README.md
- Modules documentation:
- Module Inventory to containers: docs/modules/inventory_to_container.rst.md
- Module Configlet Build configuration: docs/modules/configlet_build_config.rst.md
- AVD Plugins & Filters: plugins/README.md
- Cloudvision Module documentation: https://cvp.avd.sh/
- Contributing to AVD:
- Overview: docs/contribution/overview.md
- Setup environment: docs/contribution/setup-environment.md
- Git installation: docs/contribution/setup-git.md
- Getting Started: docs/contribution/getting-started.md
- Code Style: docs/contribution/style-guide.md
- Development tips & tricks: docs/contribution/development.md
- External resources:
- Ansible collection user guide: https://docs.ansible.com/ansible/latest/user_guide/collections_using.html
- Ansible User guide: https://docs.ansible.com/ansible/latest/user_guide/index.html
- About:
- Ansible Galaxy page: https://galaxy.ansible.com/arista/avd
- Arista CVP Collection: https://cvp.avd.sh/en/latest/
- Arista Installation Script: https://github.com/arista-netdevops-community/avd-install
- Arista Netdevops Community: https://aristanetworks.github.io/netdevops-examples/