PSPreworkout/mkdocs.yml at main · SamErde/PSPreworkout · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# https://www.mkdocs.org/user-guide/configuration/
# https://www.mkdocs.org/user-guide/writing-your-docs/
# https://www.mkdocs.org/user-guide/writing-your-docs/#writing-with-markdown
# https://mkdocs.readthedocs.io/en/0.15.2/user-guide/writing-your-docs/
# https://mkdocs.readthedocs.io/en/0.15.2/user-guide/styling-your-docs/
# https://example-mkdocs-basic.readthedocs.io/en/latest/
# https://github.com/mkdocs/mkdocs/blob/master/mkdocs.yml
# https://squidfunk.github.io/mkdocs-material/creating-your-site/
# mkdocs.yml

site_name: "PSPreworkout PowerShell Module"
site_url: "https://day3bits.com/PSPreworkout"
repo_url: "https://github.com/SamErde/PSPreworkout"
repo_name: "SamErde/PSPreworkout"
# edit_uri: edit/main/docs/
# edit_uri_template:
site_description: "PowerShell Preworkout - Documentation for the PSPreworkout PowerShell module." # meta tag to the generated HTML header
site_author: "Sam Erde" # meta tag to the generated HTML header
copyright: "(c) 2025 Sam Erde"
# remote_branch:
# remote_name:
docs_dir: "docs"
# site_dir:
# extra_css:
# extra_javascript:

markdown_extensions:
  - smarty
  - admonition
  - toc:
      permalink: true
  - pymdownx.blocks.caption
  - pymdownx.blocks.details
  - pymdownx.blocks.tab
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
  - pymdownx.keys
  - pymdownx.inlinehilite
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          # Use a plain string for format (avoid python YAML tags)
          format: "pymdownx.superfences.fence_code_format"

theme:
  name: material
  highlightjs: true
  hljs_languages:
    - yaml
    - powershell
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  language: en
  # custom_dir: overrides
  features:
    #- navigation.tabs
    #- navigation.tabs.sticky
    - navigation.path
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.follow
    - toc.integrate

  # favicon:
  # icon:
  #   repo:
  # font:
  #   text: Work Sans
  # logo:

nav:
  - Home: "index.md"
  - Customize:
      - Edit-PSReadLineHistoryFile: "Edit-PSReadLineHistoryFile.md"
      - Edit-WinGetSettingsFile: "Edit-WinGetSettingsFile.md"
      - Initialize-PSEnvironmentConfiguration: "Initialize-PSEnvironmentConfiguration.md"
      - Install-CommandNotFoundUtility: "Install-CommandNotFoundUtility.md"
      - Install-OhMyPosh: "Install-OhMyPosh.md"
      - Install-PowerShellISE: "Install-PowerShellISE.md"
      - Install-WinGet: "Install-WinGet.md"
      - Set-ConsoleFont: "Set-ConsoleFont.md"
      - Set-DefaultTerminal: "Set-DefaultTerminal.md"
  - Develop:
      - Get-LoadedAssembly: "Get-LoadedAssembly.md"
      - Get-TypeAccelerator: "Get-TypeAccelerator.md"
      - New-ScriptFromTemplate: "New-ScriptFromTemplate.md"
      - Show-LoadedAssembly: "Show-LoadedAssembly.md"
  - Daily Functions:
      - Get-CommandHistory: "Get-CommandHistory.md"
      - Get-EnvironmentVariable: "Get-EnvironmentVariable.md"
      - Get-HashtableValueType: "Get-HashtableValueType.md"
      - Get-ModulesWithUpdate: "Get-ModulesWithUpdate.md"
      - Get-PowerShellPortable: "Get-PowerShellPortable.md"
      - Out-JsonFile: "Out-JsonFile.md"
      - Set-EnvironmentVariable: "Set-EnvironmentVariable.md"
      - Show-WithoutEmptyProperty: "Show-WithoutEmptyProperty.md"
      - Test-IsElevated: "Test-IsElevated.md"
      - Update-AllTheThings: "Update-AllTheThings.md"