-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
executable file
·148 lines (135 loc) · 5.46 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
site_name: 'CI/CD Workflows'
site_url: https://automated-workflows.readthedocs.io/
site_description: CI/CD Wokflows Project Documentation.
site_author: Konstantinos Lampridis
repo_url: https://github.com/boromir674/automated-workflows/
repo_name: boromir674/automated-workflows
edit_uri: blob/main/docs/
theme:
# 1
name: material
icon:
logo: material/palette
previous: fontawesome/solid/angle-left
next: fontawesome/solid/angle-right
default: material/tag
# favicon: images/favicon.png
features:
- navigation.path
- navigation.top
- navigation.footer
# - navigation.indexes
# navigation.instant break mermaid
# features:
# - navigation.tracking
# - navigation.instant
### CSS DESIGN ###
# Allow writting css to a single css file,
# eg avoids need to add <style> elements in markdown, in case custom styles required
# extra_css:
# - css/extra.css
plugins:
# Enable jinja inside your markdown files
# - allows {% include %} statements
# - requires careful escape of double-braces in markdown
# - requires wrapping content between {% raw %} and {% endraw %}
# https://github.com/fralau/mkdocs_macros_plugin
- macros:
include_dir: docs/includes
# Authors need installation
# - git-authors
- tags:
tags_file: tags.md
# BASIC SEARCH PLUGIN
- search
# MERMAID Render Support
- mermaid2
# - literate-nav:
# nav_file: SUMMARY.md
- section-index
markdown_extensions:
- pymdownx.highlight
### ADMONITIONS ###
# enabled block kelements such as example, note, info, warning, tip, etc
# https://squidfunk.github.io/mkdocs-material/reference/admonitions/
- admonition
### SUPERFENCES ###
# arbitrary nesting of code and content blocks inside each other,
# including admonitions, tabs, lists and all other elements
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences
# this custom fence defined below with name 'mermaid' is required
# to prevent superfences from breaking mermaid default syntax (3 backticks)!
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
### TABBED ###
# usage of content tabs, a simple way to group related content and
# code blocks under accessible tabs.
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tabbed
- pymdownx.tabbed:
alternate_style: true
### GRIDS ###
- attr_list
- md_in_html
### ICONS/EMOJIS ###
# https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#with-colors-docsstylesheetsextracss
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
### On-HOVER TOOLTIP ###
# abbr by default supports tooltips on url links
- abbr
# if attr_list is also added, then tooltips on other html elements are supported as below:
# ie :material-information-outline:{ title="Important information" }
#### SIDE NAVIGATION - DESIGN ####
nav:
# each item in the list, renders a left side navigation item/page
- Home:
- "Quick Start": index.md
- How-to Guides:
- "CD: Dockerhub": "guides/guide_setup_cicd.md"
- "CD: PyPI": "guides/guide_setup_pypi.md"
- "CI: Build(s) Testing": "guides/guide_test_build.md"
- "Git Ops":
- guides/gitops/index.md
- "Setup":
- "Setup Release Me - Phase 1": "guides/gitops/setup/guide_setup_gitops_release_me.md"
- "Setup Release Me - Phase 2": "guides/gitops/setup/guide_setup_gitops_release_me_phase_2.md"
- "Automated Acceptance": "guides/gitops/setup/guide_setup_main_automated_acceptance.md"
- "Manual Acceptance": "guides/gitops/setup/guide_setup_main_manual_acceptance.md"
- "Automatic Tag on Main": "guides/gitops/setup/guide_setup_auto_tag_main.md"
- "Automatic Clean-Up": "guides/gitops/setup/guide_setup_automatic_tags_deletion.md"
- "RUN":
- "Release Me": "guides/gitops/run/guide_run_gitops_release_me_process.md"
- API References:
- "Docker": "api/ref_docker.md"
- "Github Release": "api/ref_gh-release.md"
- "PyPI": "api/ref_pypi_env.md"
- "Test Build": "api/ref_test_build.md"
- "Docs": "api/ref_policy_docs.md"
- "Lint": "api/ref_lint.md"
- "Code Visualization": "api/ref_python_imports.md"
- "Git Ops - Boarding": "api/ref_gitops_pr_to_boarding.md"
- "Single Status": "api/ref_single_status.md"
- "PR to Boarding": api/ref_go-pr-to-boarding.md
- "Single Job Status": api/ref_go-single-status.md
- pypi.yml: api/ref_pypi.md
- "Git Ops - PR to Release": api/ref_go-pr-to-release.md
- "Git Ops - PR to Main": api/ref_go-pr-to-main.md
- "Git Ops - Auto Merge to Main": "api/ref_go-auto-merge-main.md"
- "Git Ops - Tag Main": api/ref_go-tag-main.md
- "Git Ops - Clean-up Tags": api/ref_go-delete-tags.md
- Topics:
- "Single Status Workflow'": "topics/workflow_single_status_idea.md"
- "Git Ops":
- "topics/gitops/index.md"
- "Process - Release Me": "topics/gitops/release-me-process.md"
- "Process - Auto Prod": "topics/gitops/release-me-process_phase_2.md"
- "Test Suite": topics/tests_index.md
- "Semantic Release": topics/semantic-release.md
- "Development": topics/dev/dev-notes.md
- tags: tags.md
extra:
generator: false