Skip to content

Commit 5e7b595

Browse files
MariusStorhaugMariusStorhaug
authored
🩹 [Patch]: Enable publishing docs to GitHub Pages (#2)
* 🩹 [Patch]: Enable publishing docs to GitHub Pages - Bump Process-PSModule to v2 - Add pages and id-token permissions * - Add mkdocs.yml settings file * Fix * FIx * Fix
1 parent e621702 commit 5e7b595

14 files changed

Lines changed: 171 additions & 127 deletions

‎.github/linters/.markdown-lint.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
###########################
2+
## Markdown Linter rules ##
3+
###########################
4+
5+
# Linter rules doc:
6+
# - https://github.com/DavidAnson/markdownlint
7+
8+
###############
9+
# Rules by id #
10+
###############
11+
MD004: false # Unordered list style
12+
MD007:
13+
indent: 2 # Unordered list indentation
14+
MD013:
15+
line_length: 808 # Line length
16+
MD026:
17+
punctuation: ".,;:!。，；:" # List of not allowed
18+
MD029: false # Ordered list item prefix
19+
MD033: false # Allow inline HTML
20+
MD036: false # Emphasis used instead of a heading
21+
22+
#################
23+
# Rules by tags #
24+
#################
25+
blank_lines: false # Error on blank lines

‎.github/linters/.powershell-psscriptanalyzer.psd1‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#Documentation: https://github.com/PowerShell/PSScriptAnalyzer/blob/master/docs/Cmdlets/Invoke-ScriptAnalyzer.md#-settings
2+
@{
3+
#CustomRulePath='path\to\CustomRuleModule.psm1'
4+
#RecurseCustomRulePath='path\of\customrules'
5+
#Severity = @(
6+
# 'Error'
7+
# 'Warning'
8+
#)
9+
#IncludeDefaultRules=${true}
10+
ExcludeRules = @(
11+
'PSMissingModuleManifestField'
12+
)
13+
#IncludeRules = @(
14+
# 'PSAvoidUsingWriteHost',
15+
# 'MyCustomRuleName'
16+
#)
17+
}

‎.github/workflows/Linter.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Linter
2+
3+
run-name: "Linter - [${{ github.event.pull_request.title }} #${{ github.event.pull_request.number }}] by @${{ github.actor }}"
4+
5+
on: [pull_request]
6+
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.ref }}
9+
cancel-in-progress: true
10+
11+
permissions:
12+
contents: read
13+
packages: read
14+
statuses: write
15+
16+
jobs:
17+
Lint:
18+
name: Lint code base
19+
runs-on: ubuntu-latest
20+
steps:
21+
- name: Checkout repo
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Lint code base
27+
uses: super-linter/super-linter@latest
28+
env:
29+
GITHUB_TOKEN: ${{ github.token }}

‎.github/workflows/Nightly-Run.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Nightly run
2+
3+
on:
4+
workflow_dispatch:
5+
schedule:
6+
- cron: '0 0 * * *'
7+
8+
permissions:
9+
contents: write
10+
issues: write
11+
pull-requests: write
12+
statuses: write
13+
14+
jobs:
15+
Process-PSModule:
16+
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v1
17+
secrets: inherit

‎.github/workflows/Process-PSModule.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,11 @@ concurrency:
1919
permissions:
2020
contents: write
2121
pull-requests: write
22+
statuses: write
23+
pages: write
24+
id-token: write
2225

2326
jobs:
2427
Process-PSModule:
25-
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v1
28+
uses: PSModule/Process-PSModule/.github/workflows/workflow.yml@v2
2629
secrets: inherit

‎.vscode/extensions.json‎

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

‎.vscode/settings.json‎

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

‎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

‎src/GraphQL/GraphQL.psd1‎

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

‎src/GraphQL/GraphQL.psm1‎

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

0 commit comments

Comments
 (0)