-
Notifications
You must be signed in to change notification settings - Fork 2
/
mkdocs-base.yml
142 lines (132 loc) · 6.42 KB
/
mkdocs-base.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
# This file contains the common configuration options for
# draft, staging, and prod builds. This file is inherited
# to mkdocs.yml and mkdocs-prod.yml using the Configuration
# Inheritance feature documented at
# https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance
# Project Information
site_name: Get involved with the Ecosystem
site_author: Venafi Ecosystem
site_description: Building solutions to protect more machine identities
site_url: https://ecosystem.venafi.com
#Copyright
copyright: Copyright © 2024 Venafi
# Theme
theme:
name: material
custom_dir: docs/overrides #https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme
logo: assets/images/logos/Venafi_CYBR_logo_1200x377_rev.png
favicon: assets/images/Venafi_Favicon_Orange.png
features:
- navigation.instant # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading
- navigation.tabs # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#navigation-tabs
- navigation.top
- search.highlight # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-highlighting
- search.suggest # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions
- search.share # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-sharing
- content.tooltips
- toc.follow
- content.code.copy
font: # Can use any google font.
text: 'Mulish'
code: 'Roboto Mono'
palette: # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/?h=dark#color-palette-toggle
# Dark mode colors are set in assets/css/dark-mode.css
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
# Extra CSS & JS
extra_css: # Additional styelsheets to use on every page
- assets/css/colors.css
- assets/css/custom.css
- assets/css/dark-mode.css
- assets/css/mini-card.css
extra_javascript: # Additional js files to use on every page
# - https://kit.fontawesome.com/ea1de3d082.js No longer needed since we pulled the fontawesome icons off the landing page. Will reenable if needed down the road.
extra:
social: # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/#social-links
- icon: fontawesome/brands/github
link: https://github.com/venafi
- icon: fontawesome/brands/twitter
link: https://twitter.com/venafi
- icon: fontawesome/brands/linkedin-in
link: https://www.linkedin.com/company/venafi/
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/user/Venafi
- icon: fontawesome/brands/facebook-f
link: https://www.facebook.com/Venafi
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/venafiinc/
- icon: fontawesome/solid/rss
link: https://www.venafi.com/blog
# The syntax of the markdown_extensions and plugins sections below follow
# the "alternative syntax" described in https://www.mkdocs.org/user-guide/configuration/#plugins.
# This is required for the yml inheritance to work. https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance
markdown_extensions:
admonition: {} # https://python-markdown.github.io/extensions/admonition/
abbr: {} # https://squidfunk.github.io/mkdocs-material/reference/abbreviations/ extension to add additional content on hover
meta: {}
attr_list: {} # https://python-markdown.github.io/extensions/attr_list/
def_list: {} # https://python-markdown.github.io/extensions/definition_lists/
toc:
permalink: true # Generate permanent links at the end of each header
separator: "-" # Replace any white space in generated IDs with a dash
toc_depth: 3 # Two levels on the "On this page" menu
title: On this page # Sets the title of the topic toc
pymdownx.details: {} # Enables expandable sections https://facelessuser.github.io/pymdown-extensions/extensions/details/
pymdownx.tabbed: # Enables tabs https://facelessuser.github.io/pymdown-extensions/extensions/tabbed/
alternate_style: true
pymdownx.snippets:
auto_append:
- docs/.snippets/glossary.md
pymdownx.superfences: # Allows code samples to be nested in tabs https://facelessuser.github.io/pymdown-extensions/extensions/superfences/
custom_fences:
- name: mermaid # Allows rendering of sequence diagrams https://squidfunk.github.io/mkdocs-material/reference/diagrams/
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
pymdownx.magiclink: {} # Automatically links websites and email addresses https://facelessuser.github.io/pymdown-extensions/extensions/magiclink/
pymdownx.tasklist:
custom_checkbox: true
clickable_checkbox: false
pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
pymdownx.highlight:
anchor_linenums: true
pymdownx.inlinehilite:
md_in_html: {} # Allows markdown to be within html elements https://github.com/Python-Markdown/markdown/blob/master/docs/extensions/md_in_html.md
pyembed.markdown: {}
plugins:
search: {}
encryptcontent: {}
autolinks: {}
# include-markdown: {}
section-index: {}
macros: # https://mkdocs-macros-plugin.readthedocs.io/en/latest/
include_yaml:
- docs/.variables/general.yml
include_dir: docs/.snippets
literate-nav: # https://github.com/oprypin/mkdocs-literate-nav
nav_file: nav.md
# exclude-search: # https://github.com/chrieke/mkdocs-exclude-search
# exclude:
redirects: # https://github.com/datarobot/mkdocs-redirects
redirect_maps:
glightbox:
touchNavigation: true
loop: false
effect: zoom
slide_effect: slide
width: 100%
height: auto
zoomable: true
draggable: true
skip_classes:
auto_caption: false
caption_position: bottom