-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
182 lines (166 loc) · 5.29 KB
/
Copy pathmkdocs.yml
File metadata and controls
182 lines (166 loc) · 5.29 KB
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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
site_name: Versioner Documentation
site_url: https://docs.versioner.io
site_description: Deployment governance for engineering teams
site_author: Versioner Team
repo_url: https://github.com/versioner-io/versioner-docs
repo_name: versioner-io/versioner-docs
# Only build from the public/ directory
docs_dir: public
site_dir: site
# Theme configuration
theme:
name: material
custom_dir: overrides
logo: assets/versioner-logo.png
favicon: assets/versioner-logo.png
palette:
# Dark mode only
scheme: slate
primary: teal
accent: teal
font:
text: Roboto
code: Roboto Mono
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- navigation.tracking
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.code.annotate
- content.tooltips
icon:
repo: fontawesome/brands/github
# Extra CSS
extra_css:
- stylesheets/extra.css
# Navigation structure
nav:
- Home: index.md
- Getting Started: getting-started/index.md
- Guides:
- Overview: guides/index.md
- Setting Up Notifications: guides/notifications.md
- Configuring Deployment Buttons: guides/deployment-buttons.md
- Tracking Terraform / IaC Versions: guides/terraform.md
- Integrations:
- Overview: integrations/index.md
- Troubleshooting: integrations/troubleshooting.md
- Native Integrations:
- Overview: integrations/native/index.md
- GitHub Action: integrations/native/github-action.md
- Vercel: integrations/native/vercel.md
- CLI:
- Overview: cli/index.md
- Installation: cli/installation.md
- Usage: cli/usage.md
- GitHub Actions: cli/github-actions.md
- GitLab CI: cli/gitlab-ci.md
- Jenkins: cli/jenkins.md
- CircleCI: cli/circleci.md
- Bitbucket Pipelines: cli/bitbucket-pipelines.md
- Azure DevOps: cli/azure-devops.md
- Travis CI: cli/travis-ci.md
- Rundeck: cli/rundeck.md
- REST API:
- Overview: api/index.md
- Authentication: api/authentication.md
- Event Tracking: api/event-tracking.md
- AI Agents:
- MCP Server: ai-agents/mcp.md
- Concepts:
- Overview: concepts/index.md
- How It Works: concepts/how-it-works.md
- Products: concepts/catalog/products.md
- Versions: concepts/catalog/versions.md
- Environments: concepts/catalog/environments.md
- Deployments: concepts/catalog/deployments.md
- Governance:
- Environment State Matrix: concepts/governance/environment-state-matrix.md
- Deployment Requests: concepts/governance/deployment-requests.md
- Deployment Rules: concepts/governance/deployment-rules.md
- Reference:
- Variables: reference/variables.md
- User Roles: reference/user-roles.md
- API Event Types: reference/event-types.md
- API Response Codes: reference/response-codes.md
- API Interactive Docs: reference/interactive-docs.md
# Markdown extensions
markdown_extensions:
# Admonitions (callouts)
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
# Code highlighting
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
# Tabbed content
- pymdownx.tabbed:
alternate_style: true
# Task lists
- pymdownx.tasklist:
custom_checkbox: true
# Emoji support
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
# Tables
- tables
# Table of contents
- toc:
permalink: true
toc_depth: 3
# Footnotes
- footnotes
# Abbreviations
- abbr
- attr_list
- md_in_html
# Plugins
plugins:
- search:
lang: en
- git-revision-date-localized:
enable_creation_date: true
type: timeago
- redirects:
redirect_maps:
getting-started/quick-start.md: getting-started/index.md
getting-started/how-it-works.md: concepts/how-it-works.md
integrations/github-action.md: integrations/native/github-action.md
integrations/vercel.md: integrations/native/vercel.md
agents/index.md: ai-agents/mcp.md
agents/mcp.md: ai-agents/mcp.md
integrations/mcp.md: ai-agents/mcp.md
concepts/configuration/notifications.md: guides/notifications.md
concepts/configuration/deployment-buttons.md: guides/deployment-buttons.md
concepts/configuration/variables.md: reference/variables.md
concepts/configuration/user-roles.md: reference/user-roles.md
api/event-types.md: reference/event-types.md
api/interactive-docs.md: reference/interactive-docs.md
api/response-codes.md: reference/response-codes.md
# Extra configuration
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/versioner-io/versioner-api
name: Versioner on GitHub
analytics:
provider: google
property: !ENV GOOGLE_ANALYTICS_KEY
# version:
# provider: mike
# Copyright
copyright: Copyright © 2026 Versioner