Skip to content

Commit 4c63c2e

Browse files
Add initial Zensical configuration and create index documentation
1 parent 29545da commit 4c63c2e

3 files changed

Lines changed: 162 additions & 0 deletions

File tree

.github/workflows/Pages.yml

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: Publish Site
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- main
8+
paths:
9+
- docs/**
10+
- zensical.toml
11+
- .github/workflows/Pages.yml
12+
13+
concurrency:
14+
group: ${{ github.workflow }}-${{ github.ref }}
15+
cancel-in-progress: false
16+
17+
permissions:
18+
contents: read
19+
20+
jobs:
21+
build:
22+
name: Build and deploy site
23+
runs-on: ubuntu-24.04
24+
environment:
25+
name: github-pages
26+
url: ${{ steps.deployment.outputs.page_url }}
27+
permissions:
28+
contents: read
29+
pages: write
30+
id-token: write
31+
steps:
32+
- uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
33+
34+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
35+
with:
36+
persist-credentials: false
37+
38+
- uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
39+
with:
40+
python-version: 3.x
41+
42+
- name: Install Zensical
43+
run: pip install zensical
44+
45+
- name: Build Zensical project
46+
run: zensical build --clean
47+
48+
- uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
49+
with:
50+
path: site
51+
52+
- uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
53+
id: deployment

docs/index.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
6+
7+
# A GitHub & PowerShell development framework
8+
9+
We empower PowerShell-savvy developers to effortlessly transform their ideas into impactful solutions.
10+
Our approach centres around a development framework that lets developers focus on delivering value through their code —
11+
by leveraging GitHub and PowerShell to automate repetitive tasks, so you can concentrate on what matters most.
12+
13+
<div class="grid cards" markdown>
14+
15+
- :material-book-open-outline: **Documentation**
16+
17+
---
18+
19+
Guides, standards, and ways of working for building with PSModule.
20+
21+
[:octicons-arrow-right-24: Read the docs](https://psmodule.io/docs/)
22+
23+
- :material-package-variant: **PowerShell Gallery**
24+
25+
---
26+
27+
Browse and install all published PSModule packages.
28+
29+
[:octicons-arrow-right-24: Open PowerShell Gallery](https://www.powershellgallery.com/profiles/PSModule.io)
30+
31+
- :fontawesome-brands-github: **GitHub**
32+
33+
---
34+
35+
Explore the source code and contribute to the framework.
36+
37+
[:octicons-arrow-right-24: Visit GitHub](https://github.com/PSModule)
38+
39+
- :fontawesome-brands-discord: **Community**
40+
41+
---
42+
43+
Join the conversation and get help from the community.
44+
45+
[:octicons-arrow-right-24: Join Discord](https://discord.gg/jedJWCPAhD)
46+
47+
</div>

zensical.toml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Zensical configuration
2+
# https://zensical.org/docs/setup/basics/
3+
4+
[project]
5+
site_name = "PSModule"
6+
site_url = "https://psmodule.io/"
7+
docs_dir = "docs"
8+
repo_name = "PSModule"
9+
repo_url = "https://github.com/PSModule"
10+
copyright = "Copyright &copy; 2023 - 2025 PSModule"
11+
12+
[project.theme]
13+
language = "en"
14+
font.text = "Mona Sans"
15+
font.code = "Source Code Pro"
16+
features = [
17+
"navigation.instant",
18+
"navigation.instant.progress",
19+
"navigation.top",
20+
]
21+
22+
[project.theme.icon]
23+
repo = "material/github"
24+
25+
# Palette toggle for dark mode
26+
[[project.theme.palette]]
27+
media = "(prefers-color-scheme: dark)"
28+
scheme = "slate"
29+
primary = "black"
30+
accent = "light blue"
31+
toggle.icon = "material/toggle-switch-off-outline"
32+
toggle.name = "Switch to light mode"
33+
34+
# Palette toggle for light mode
35+
[[project.theme.palette]]
36+
media = "(prefers-color-scheme: light)"
37+
scheme = "default"
38+
primary = "black"
39+
accent = "light blue"
40+
toggle.icon = "material/toggle-switch"
41+
toggle.name = "Switch to system preference"
42+
43+
[project.plugins.search]
44+
45+
[project.markdown_extensions.attr_list]
46+
47+
[project.markdown_extensions.md_in_html]
48+
49+
[[project.extra.social]]
50+
icon = "fontawesome/brands/discord"
51+
link = "https://discord.gg/jedJWCPAhD"
52+
name = "PSModule on Discord"
53+
54+
[[project.extra.social]]
55+
icon = "material/powershell"
56+
link = "https://www.powershellgallery.com/profiles/PSModule.io"
57+
name = "PSModule on the PowerShell Gallery"
58+
59+
[[project.extra.social]]
60+
icon = "fontawesome/brands/github"
61+
link = "https://github.com/PSModule/"
62+
name = "PSModule on GitHub"

0 commit comments

Comments
 (0)