forked from Be-Secure/BeSLighthouse
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
201 lines (191 loc) · 6.27 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
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# Project information
site_name: BeSLighthouse
site_url: "https://be-secure.github.io/BeSLighthouse/"
site_description: >-
Community Dashboard for security assessment of TAVOSS components.
# Repository
repo_name: Be-Secure/BeSLighthouse
repo_url: https://github.com/Be-Secure/BeSLighthouse
edit_uri: ""
base_url: bes_theme
# Copyright
# #
# Configuration
theme:
name: null
custom_dir: !ENV [THEME_DIR, "bes_theme"]
# Static files
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
features:
- content.code.annotate
- content.tabs.link
# - navigation.instant
- navigation.sections
- navigation.tabs
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: bes_theme/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: red
accent: red
toggle:
icon: bes_theme/toggle-switch
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
favicon: assets/favicon.png
# logo: assets/favicon.png
icon:
logo: logo
# # Plugins
# plugins:
# - search
# - redirects:
# redirect_maps:
# changelog/insiders.md: insiders/changelog.md
# extensions/admonition.md: reference/admonitions.md
# extensions/codehilite.md: reference/code-blocks.md
# extensions/footnotes.md: reference/footnotes.md
# extensions/metadata.md: reference/meta-tags.md
# extensions/permalinks.md: setup/setting-up-navigation.md #permalink
# extensions/pymdown.md: reference/admonitions.md
# plugins/revision-date.md: setup/adding-a-git-repository.md #revision-date
# plugins/search.md: setup/setting-up-site-search.md
# releases/4.md: upgrading.md #upgrading-from-4x-to-5x
# releases/5.md: upgrading.md #upgrading-from-3x-to-4x
# releases/changelog.md: changelog.md
# setup/adding-social-links.md: setup/setting-up-the-footer.md
# sponsorship.md: insiders/index.md
# - minify:
# minify_html: true
# Customization
# extra:
# analytics:
# provider: google
# # property: !ENV GOOGLE_ANALYTICS_KEY
# social:
# - icon: fontawesome/brands/github
# link: https://github.com/squidfunk
# - icon: fontawesome/brands/gitter
# link: https://gitter.im/squidfunk/Be-Secure
# - icon: fontawesome/brands/docker
# link: https://hub.docker.com/r/squidfunk/Be-Secure/
# - icon: fontawesome/brands/twitter
# link: https://twitter.com/squidfunk
# - icon: fontawesome/brands/linkedin
# link: https://linkedin.com/in/squidfunk/
# - icon: fontawesome/brands/instagram
# link: https://instagram.com/squidfunk
# Extensions
markdown_extensions:
# - admonition
# - abbr
# - attr_list
# - def_list
# - footnotes
- meta
# - md_in_html
# - toc:
# permalink: true
# - pymdownx.arithmatex:
# generic: true
# - pymdownx.betterem:
# smart_enable: all
# - pymdownx.caret
# - pymdownx.critic
# - pymdownx.details
# - pymdownx.emoji:
# emoji_index: !!python/name:bes_themex.emoji.twemoji
# emoji_generator: !!python/name:bes_themex.emoji.to_svg
# - pymdownx.highlight
# - pymdownx.inlinehilite
# - pymdownx.keys
# - pymdownx.magiclink:
# repo_url_shorthand: true
# user: squidfunk
# repo: Be-Secure
# - pymdownx.mark
# - pymdownx.smartsymbols
# - pymdownx.superfences:
# custom_fences:
# - name: mermaid
# class: mermaid-experimental
# format: !!python/name:pymdownx.superfences.fence_code_format
# - pymdownx.tabbed
# - pymdownx.tasklist:
# custom_checkbox: true
# - pymdownx.tilde
# Page tree
nav:
- Home: index.md
- Dashboard: bes_visualisation.md
- Projects of Interest: projectOfInterest.md
# - Tech stack: tech_stack.md
# - Tracked OSS projects: projects_we_track.md
# - Our OSS projects: our_oss_project.md
# - Security Assessment: assessment.md
# - Contribute: contribute.md
# - Insiders: insiders/index.md
# - Getting started:
# - Installation: getting-started.md
# - Creating your site: creating-your-site.md
# - Publishing your site: publishing-your-site.md
# - Customization: customization.md
# - Troubleshooting: troubleshooting.md
# - Data privacy: data-privacy.md
# - License: license.md
# - Releases:
# - Changelog: changelog.md
# - Upgrade guide: upgrading.md
# - Deprecations: deprecations.md
# - Setup:
# - Changing the colors: setup/changing-the-colors.md
# - Changing the fonts: setup/changing-the-fonts.md
# - Changing the language: setup/changing-the-language.md
# - Changing the logo and icons: setup/changing-the-logo-and-icons.md
# - Setting up navigation: setup/setting-up-navigation.md
# - Setting up site search: setup/setting-up-site-search.md
# - Setting up site analytics: setup/setting-up-site-analytics.md
# - Setting up tags: setup/setting-up-tags.md
# - Setting up versioning: setup/setting-up-versioning.md
# - Setting up the header: setup/setting-up-the-header.md
# - Setting up the footer: setup/setting-up-the-footer.md
# - Adding a git repository: setup/adding-a-git-repository.md
# - Adding a comment system: setup/adding-a-comment-system.md
# - Reference:
# - Abbreviations: reference/abbreviations.md
# - Admonitions: reference/admonitions.md
# - Buttons: reference/buttons.md
# - Code blocks: reference/code-blocks.md
# - Content tabs: reference/content-tabs.md
# - Data tables: reference/data-tables.md
# - Diagrams: reference/diagrams.md
# - Footnotes: reference/footnotes.md
# - Formatting: reference/formatting.md
# - Icons + Emojis: reference/icons-emojis.md
# - Images: reference/images.md
# - Lists: reference/lists.md
# - MathJax: reference/mathjax.md
# - Meta tags: reference/meta-tags.md
# - Variables: reference/variables.md
# - Insiders:
# - Sponsorship: insiders/index.md
# - Getting started:
# - Installation: insiders/getting-started.md
# - Changelog: insiders/changelog.md