Skip to content

Commit acec0b1

Browse files
🩹 [Patch]: Enable docs on a repo generated Template-PSModule (#6)
## Description - Enable docs on a repo generated Template-PSModule. ## Type of change <!-- Use the check-boxes [x] on the options that are relevant. --> - [ ] 📖 [Docs] - [ ] 🪲 [Fix] - [x] 🩹 [Patch] - [ ] ⚠️ [Security fix] - [ ] 🚀 [Feature] - [ ] 🌟 [Breaking change] ## Checklist <!-- Use the check-boxes [x] on the options that are relevant. --> - [x] I have performed a self-review of my own code - [x] I have commented my code, particularly in hard-to-understand areas
1 parent 8cb8444 commit acec0b1

File tree

4 files changed

+82
-9
lines changed

4 files changed

+82
-9
lines changed

.github/dependabot.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,3 @@ updates:
99
directory: / # Location of package manifests
1010
schedule:
1111
interval: weekly
12-
- package-ecosystem: nuget # See documentation for possible values
13-
directory: / # Location of package manifests
14-
schedule:
15-
interval: weekly

.github/workflows/Process-PSModule.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ permissions:
2121
contents: write
2222
pull-requests: write
2323
statuses: write
24+
pages: write
25+
id-token: write
2426

2527
jobs:
2628
Process-PSModule:
27-
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v1
29+
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v2
2830
secrets: inherit

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# PSModuleTemplate
1+
# {{ NAME }}
22

3-
A PowerShell module template that can be used to create new modules.
3+
{{ DESCRIPTION }}
44

55
## Prerequisites
66

@@ -12,8 +12,8 @@ This uses the following external resources:
1212
To install the module from the PowerShell Gallery, you can use the following command:
1313

1414
```powershell
15-
Install-PSResource -Name YourModuleName
16-
Import-Module -Name YourModuleName
15+
Install-PSResource -Name {{ NAME }}
16+
Import-Module -Name {{ NAME }}
1717
```
1818

1919
## Usage

mkdocs.yml

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

0 commit comments

Comments
 (0)