Skip to content

Commit b0bb6a0

Browse files
Adopt Zensical-first docs configuration (#40)
## Summary - add `.github/zensical.toml` as the documentation site configuration - remove `.github/mkdocs.yml` to enforce a clean cut to Zensical - preserve `-{{ REPO_NAME }}-` and `-{{ REPO_OWNER }}-` placeholders for Process-PSModule substitution ## Result - repository documentation configuration is Zensical-only --------- Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent d37a05d commit b0bb6a0

3 files changed

Lines changed: 80 additions & 76 deletions

File tree

.github/mkdocs.yml

Lines changed: 0 additions & 75 deletions
This file was deleted.

.github/workflows/Process-PSModule.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ permissions:
2727

2828
jobs:
2929
Process-PSModule:
30-
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@8b1a2617a0686ceaeadc6fa8e2f395edda93cc6d # v6.1.7
30+
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@migrate-to-zensical
3131
secrets:
3232
APIKey: ${{ secrets.APIKey }}
3333
TestData: >-

.github/zensical.toml

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
[project]
2+
site_name = "-{{ REPO_NAME }}-"
3+
repo_name = "-{{ REPO_OWNER }}-/-{{ REPO_NAME }}-"
4+
repo_url = "https://github.com/-{{ REPO_OWNER }}-/-{{ REPO_NAME }}-"
5+
6+
[project.theme]
7+
language = "en"
8+
font.text = "Roboto"
9+
font.code = "Sono"
10+
logo = "Assets/icon.png"
11+
favicon = "Assets/icon.png"
12+
features = [
13+
"content.code.copy",
14+
"navigation.instant",
15+
"navigation.instant.progress",
16+
"navigation.indexes",
17+
"navigation.top",
18+
"navigation.tracking",
19+
"navigation.expand",
20+
"search.suggest",
21+
"search.highlight",
22+
]
23+
24+
[project.theme.icon]
25+
repo = "material/github"
26+
27+
[[project.theme.palette]]
28+
media = "(prefers-color-scheme)"
29+
toggle.icon = "material/link"
30+
toggle.name = "Switch to dark mode"
31+
32+
[[project.theme.palette]]
33+
media = "(prefers-color-scheme: dark)"
34+
scheme = "slate"
35+
primary = "black"
36+
accent = "green"
37+
toggle.icon = "material/toggle-switch-off-outline"
38+
toggle.name = "Switch to light mode"
39+
40+
[[project.theme.palette]]
41+
media = "(prefers-color-scheme: light)"
42+
scheme = "default"
43+
primary = "indigo"
44+
accent = "green"
45+
toggle.icon = "material/toggle-switch"
46+
toggle.name = "Switch to system preference"
47+
48+
[project.plugins.search]
49+
50+
[project.markdown_extensions.toc]
51+
permalink = true
52+
53+
[project.markdown_extensions.attr_list]
54+
55+
[project.markdown_extensions.admonition]
56+
57+
[project.markdown_extensions.md_in_html]
58+
59+
[project.markdown_extensions.pymdownx.details]
60+
61+
[project.extra.consent]
62+
title = "Cookie consent"
63+
description = """
64+
We use cookies to recognize your repeated visits and preferences, as well
65+
as to measure the effectiveness of our documentation and whether users
66+
find what they're searching for. With your consent, you're helping us to
67+
make our documentation better.
68+
"""
69+
actions = ["accept", "reject"]
70+
71+
[[project.extra.social]]
72+
icon = "fontawesome/brands/discord"
73+
link = "https://discord.gg/jedJWCPAhD"
74+
name = "-{{ REPO_OWNER }}- on Discord"
75+
76+
[[project.extra.social]]
77+
icon = "fontawesome/brands/github"
78+
link = "https://github.com/-{{ REPO_OWNER }}-/"
79+
name = "-{{ REPO_OWNER }}- on GitHub"

0 commit comments

Comments
 (0)