From 5a6d09bbe6b6e88406d5a01970b2a5f0986762fd Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 20 Jul 2024 18:46:14 +0200 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Enable=20publishi?= =?UTF-8?q?ng=20docs=20to=20GitHub=20Pages=20-=20Bump=20Process-PSModule?= =?UTF-8?q?=20to=20v2=20-=20Add=20pages=20and=20id-token=20permissions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/Process-PSModule.yml | 4 +++- src/{en_US => en-US}/about_Auth.help.txt | 0 src/{en_US => en-US}/about_Config.help.txt | 0 3 files changed, 3 insertions(+), 1 deletion(-) rename src/{en_US => en-US}/about_Auth.help.txt (100%) rename src/{en_US => en-US}/about_Config.help.txt (100%) diff --git a/.github/workflows/Process-PSModule.yml b/.github/workflows/Process-PSModule.yml index 22aef7c0c..28b577592 100644 --- a/.github/workflows/Process-PSModule.yml +++ b/.github/workflows/Process-PSModule.yml @@ -21,10 +21,12 @@ permissions: contents: write pull-requests: write statuses: write + pages: write + id-token: write jobs: Process-PSModule: - uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v1 + uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v2 secrets: inherit with: SkipTests: Desktop diff --git a/src/en_US/about_Auth.help.txt b/src/en-US/about_Auth.help.txt similarity index 100% rename from src/en_US/about_Auth.help.txt rename to src/en-US/about_Auth.help.txt diff --git a/src/en_US/about_Config.help.txt b/src/en-US/about_Config.help.txt similarity index 100% rename from src/en_US/about_Config.help.txt rename to src/en-US/about_Config.help.txt From adc0749a65ea1d8b4989539779cf321015ad3b85 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sat, 20 Jul 2024 21:10:56 +0200 Subject: [PATCH 2/2] - Add mkdocs.yml settings file --- mkdocs.yml | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 mkdocs.yml diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..df5e17ada --- /dev/null +++ b/mkdocs.yml @@ -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