generated from PSModule/Template-PSModule
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🩹 [Patch]: Enable publishing docs to GitHub Pages (#19)
## Description - Bump Process-PSModule to v2 - Add pages and id-token permissions - Add mkdocs.yml settings file ## 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
- Loading branch information
1 parent
3e1f581
commit e9210e1
Showing
2 changed files
with
78 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
site_name: -{{ REPO_NAME }}- | ||
theme: | ||
name: material | ||
language: en | ||
font: | ||
text: Roboto | ||
code: Sono | ||
logo: Assets/icon.png | ||
favicon: Assets/icon.png | ||
palette: | ||
# Palette toggle for automatic mode | ||
- media: "(prefers-color-scheme)" | ||
toggle: | ||
icon: material/link | ||
name: Switch to dark mode | ||
# Palette toggle for dark mode | ||
- media: '(prefers-color-scheme: dark)' | ||
scheme: slate | ||
toggle: | ||
primary: black | ||
accent: green | ||
icon: material/toggle-switch-off-outline | ||
name: Switch to light mode | ||
# Palette toggle for light mode | ||
- media: '(prefers-color-scheme: light)' | ||
scheme: default | ||
toggle: | ||
primary: indigo | ||
accent: green | ||
icon: material/toggle-switch | ||
name: Switch to system preference | ||
icon: | ||
repo: material/github | ||
features: | ||
- navigation.instant | ||
- navigation.instant.progress | ||
- navigation.indexes | ||
- navigation.top | ||
- navigation.tracking | ||
- navigation.expand | ||
- search.suggest | ||
- search.highlight | ||
|
||
repo_name: -{{ REPO_OWNER }}-/-{{ REPO_NAME }}- | ||
repo_url: https://github.com/-{{ REPO_OWNER }}-/-{{ REPO_NAME }}- | ||
|
||
plugins: | ||
- search | ||
|
||
markdown_extensions: | ||
- toc: | ||
permalink: true # Adds a link icon to headings | ||
- attr_list | ||
- admonition | ||
- md_in_html | ||
- pymdownx.details # Enables collapsible admonitions | ||
|
||
extra: | ||
social: | ||
- icon: fontawesome/brands/discord | ||
link: https://discord.gg/jedJWCPAhD | ||
name: -{{ REPO_OWNER }}- on Discord | ||
- icon: fontawesome/brands/github | ||
link: https://github.com/-{{ REPO_OWNER }}-/ | ||
name: -{{ REPO_OWNER }}- on GitHub | ||
consent: | ||
title: Cookie consent | ||
description: >- | ||
We use cookies to recognize your repeated visits and preferences, as well | ||
as to measure the effectiveness of our documentation and whether users | ||
find what they're searching for. With your consent, you're helping us to | ||
make our documentation better. | ||
actions: | ||
- accept | ||
- reject |