py-bootstrap/zensical.toml at main · npikall/py-bootstrap · GitHub

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
[project]
# Read more: https://zensical.org/docs/setup/basics/#site_name
site_name = "PyBootstrap"
site_description = "Bootstrap your Python Development Experience."
site_author = "Niko Pikall"
repo_url = "https://github.com/npikall/py-bootstrap"
repo_name = "npikall/py-bootstrap"
copyright = """
Copyright &copy; 2025-2026 Niko Pikall
"""
nav = [
	{ "Home" = "index.md" },
	{ "Setup" = "setup.md" },
	{ "Create new Project" = "create.md" },
	{ "Template" = "template.md" },
	{ "Update a Project" = "update.md" },
	{ "Migrate a Project" = "migrate.md" },
	{ "License" = "license.md" },
	{ "Changelog" = "changelog.md" },
	{ "Contributing" = "contributing.md" },
]
#extra_css = ["assets/stylesheets/extra.css"]
#extra_javascript = ["assets/javascript/extra.js"]

[project.theme]
# change this to "classic" to use the traditional Material for MkDocs look.
# variant = "classic"


#custom_dir = "overrides"
favicon = "assets/rocket.svg"
language = "en"
logo = "assets/rocket.svg"

features = [
	"announce.dismiss",
	"content.code.annotate",
	"content.code.copy",
	"content.code.select",
	"content.footnote.tooltips",
	"content.tabs.link",
	"content.tooltips",
	"navigation.footer",
	"navigation.indexes",
	"navigation.instant",
	"navigation.instant.prefetch",
	"navigation.path",
	"navigation.sections",
	# "navigation.tabs",
	"navigation.top",
	"navigation.tracking",
	"search.highlight",
]

# Palette toggle for automatic mode
[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "lucide/sun-moon"
toggle.name = "Switch to light mode"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
accent = "deep orange"
primary = "deep orange"
scheme = "default"
toggle.icon = "lucide/sun"
toggle.name = "Switch to dark mode"

# Palette toggle for dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
accent = "deep orange"
primary = "deep orange"
scheme = "slate"
toggle.icon = "lucide/moon"
toggle.name = "Switch to light mode"

[project.theme.icon]
logo = "assets/rocket.svg"

# Default Zensical Extensions
[project.markdown_extensions.abbr]
[project.markdown_extensions.admonition]
[project.markdown_extensions.attr_list]
[project.markdown_extensions.def_list]
[project.markdown_extensions.footnotes]
[project.markdown_extensions.md_in_html]
[project.markdown_extensions.toc]
# permalink = true
permalink = "⚓︎"
[project.markdown_extensions.pymdownx.arithmatex]
generic = true
[project.markdown_extensions.pymdownx.betterem]
smart_enable = "all"
[project.markdown_extensions.pymdownx.caret]
[project.markdown_extensions.pymdownx.details]
[project.markdown_extensions.pymdownx.emoji]
emoji_generator = "zensical.extensions.emoji.to_svg"
emoji_index = "zensical.extensions.emoji.twemoji"
[project.markdown_extensions.pymdownx.highlight]
[project.markdown_extensions.pymdownx.inlinehilite]
[project.markdown_extensions.pymdownx.keys]
[project.markdown_extensions.pymdownx.mark]
[project.markdown_extensions.pymdownx.smartsymbols]
[project.markdown_extensions.pymdownx.superfences]
[project.markdown_extensions.pymdownx.tabbed]
alternate_style = true
[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true
clickable_checkbox = true
[project.markdown_extensions.pymdownx.tilde]

# Additional Extensions
[project.markdown_extensions.pymdownx.snippets]