Repository navigation
Expand file tree
/
Copy pathzensical.toml
More file actions
112 lines (104 loc) · 3.86 KB
/
Copy pathzensical.toml
File metadata and controls
112 lines (104 loc) · 3.86 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
# Documentation site for docs/, built with Zensical and published to GitHub Pages by
# .github/workflows/docs.yml (#1070). Preview it locally with `uv run zensical serve`.
[project]
site_name = "OWASP Security Shepherd"
site_description = "Documentation for OWASP Security Shepherd, a web and mobile application security training platform."
site_url = "https://owasp.github.io/SecurityShepherd/"
repo_url = "https://github.com/OWASP/SecurityShepherd"
repo_name = "OWASP/SecurityShepherd"
edit_uri = "edit/dev/docs/"
# docker-hub-overview.md is the Docker Hub repository overview, published by release.yml.
exclude_docs = """
docker-hub-overview.md
"""
# The theme loads Mermaid from unpkg.com, unpinned, unless a `mermaid` global already exists. This
# self-hosted copy keeps visitors' browsers from contacting a third party, as `font = false` does
# for fonts. It's mermaid 12.2.0 from npm, checked against the registry's sha512; AGENTS.md says
# how to update it.
extra_javascript = ["assets/javascripts/mermaid/mermaid.min.js"]
nav = [
{ "Home" = "index.md" },
{ "Getting started" = "getting-started.md" },
{ "Playing" = [
{ "How Shepherd works" = "how-shepherd-works.md" },
{ "Setting up your tools" = "setting-up-your-tools.md" },
{ "The levels" = "levels.md" },
{ "Mobile levels" = "mobile-levels.md" },
] },
{ "Running Security Shepherd" = [
{ "Deploying into production" = "deploying-into-production.md" },
{ "Manual setup" = "manual-setup.md" },
{ "Upgrading" = "upgrading.md" },
{ "Backups and restore" = "backups.md" },
{ "Running a CTF" = "running-a-ctf.md" },
{ "Admin menu reference" = "admin-menu.md" },
{ "Single sign-on" = "single-sign-on.md" },
{ "Translations" = "translations.md" },
{ "Reskinning" = "reskinning.md" },
{ "Troubleshooting" = "troubleshooting.md" },
] },
{ "Security" = [
{ "Verifying the images" = "verifying-images.md" },
{ "Vulnerability management" = "vulnerability-management.md" },
] },
{ "Reference" = [
{ "Configuration" = "configuration.md" },
{ "Glossary" = "glossary.md" },
] },
{ "Contributing" = [
{ "Development workflow" = "development-workflow.md" },
{ "Running tests" = "testing.md" },
{ "Architecture" = "architecture.md" },
{ "Database layer" = "database-layer.md" },
{ "Creating a level" = "creating-a-level.md" },
{ "Translating Security Shepherd" = "translating.md" },
{ "Releasing" = "releasing.md" },
] },
]
[project.theme]
# Holds the announcement bar (main.html).
custom_dir = "zensical-overrides"
language = "en"
# Serve the system font stack instead of loading Google Fonts, which would share every
# visitor's IP address with Google.
font = false
features = [
"content.action.edit",
"content.code.copy",
"navigation.footer",
"navigation.indexes",
"navigation.instant",
"navigation.path",
"navigation.sections",
"navigation.top",
"navigation.tracking",
"search.highlight",
]
[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "lucide/sun-moon"
toggle.name = "Switch to light mode"
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to system preference"
# Only extensions that match how GitHub renders Markdown, so every page reads the same on
# github.com and on the site.
[project.markdown_extensions]
toc.permalink = true
pymdownx.betterem = {}
pymdownx.highlight.anchor_linenums = true
pymdownx.highlight.pygments_lang_class = true
pymdownx.inlinehilite = {}
pymdownx.magiclink = {}
pymdownx.superfences.custom_fences = [
{ name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]
pymdownx.tasklist.custom_checkbox = true
pymdownx.tilde = {}