zensical.toml

# Zensical configuration
# https://zensical.org/docs/setup/basics/

[project]
site_name = "PSModule / Docs"
site_url = "https://psmodule.io/docs/"
docs_dir = "docs"
repo_name = "PSModule/docs"
repo_url = "https://github.com/PSModule/docs"
edit_uri = "edit/main/docs/"
copyright = "Copyright © 2023 - 2025 PSModule"
extra_css = ["assets/stylesheets/extra.css"]
extra_javascript = [
  "https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js",
  "assets/javascripts/tablesort.js",
]
watch = ["includes"]
nav = [
  {"PowerShell" = [
    "PowerShell/index.md",
    {"Standard" = [
      "PowerShell/Standard/index.md",
      {"Code Layout" = "PowerShell/Standard/Code-Layout.md"},
      {"Naming" = "PowerShell/Standard/Naming.md"},
      {"Function Structure" = "PowerShell/Standard/Function-Structure.md"},
      {"Documentation" = "PowerShell/Standard/Documentation.md"},
      {"Readability" = "PowerShell/Standard/Readability.md"},
      {"Control Flow" = "PowerShell/Standard/Control-Flow.md"},
      {"Output and Errors" = "PowerShell/Standard/Output-and-Errors.md"},
      {"Performance" = "PowerShell/Standard/Performance.md"},
      {"Testing" = "PowerShell/Standard/Testing.md"},
      {"Security" = "PowerShell/Standard/Security.md"},
    ]},
    {"Modules" = [
      "PowerShell/Modules/index.md",
      {"Standards" = "PowerShell/Modules/Standards.md"},
      {"Test Specification" = "PowerShell/Modules/Test-Specification.md"},
      {"Versioning" = "PowerShell/Modules/Versioning.md"},
    ]},
    {"Scripts" = [
      "PowerShell/Scripts/index.md",
      {"Standards" = "PowerShell/Scripts/Standards.md"},
    ]},
    {"DSC" = [
      "PowerShell/DSC/index.md",
    ]},
    {"Function Apps" = [
      "PowerShell/FunctionApps/index.md",
    ]},
  ]},
  {"GitHub Actions" = [
    "GitHub-Actions/index.md",
    {"Standards" = "GitHub-Actions/Standards.md"},
  ]},
  {"Style Guides" = [
    "Style-Guides/index.md",
    {"GitHub Actions" = "Style-Guides/GitHub-Actions.md"},
    {"Markdown" = "Style-Guides/Markdown.md"},
    {"PowerShell" = "Style-Guides/PowerShell.md"},
  ]},
  {"Solutions" = [
    "Solutions/index.md",
    {"Infusing GitHub with PowerShell" = "Solutions/Infusing-GitHub-with-PowerShell.md"},
    {"GitHub Copilot Customization" = "Solutions/GitHub-Copilot-Customization-Architecture.md"},
    {"Self-Service System" = "Solutions/Self-service-system.md"},
  ]},
  {"Ways of Working" = [
    "Ways-of-Working/index.md",
    {"Workflow" = "Ways-of-Working/Workflow.md"},
    {"Principles" = "Ways-of-Working/Principles.md"},
    {"Goal-Setting Framework" = "Ways-of-Working/Goal-Setting.md"},
    {"Issue Format" = "Ways-of-Working/Issue-Format.md"},
    {"Issue Hierarchy" = "Ways-of-Working/Issue-Hierarchy.md"},
    {"PR Format" = "Ways-of-Working/PR-Format.md"},
    {"Commit Conventions" = "Ways-of-Working/Commit-Conventions.md"},
    {"Review Etiquette" = "Ways-of-Working/Review-Etiquette.md"},
    {"README-Driven Context" = "Ways-of-Working/Readme-Driven-Context.md"},
    {"Git Worktrees" = "Ways-of-Working/Git-Worktrees.md"},
  ]},
  {"Dictionary" = [
    "Dictionary/index.md",
  ]},
]

[project.theme]
language = "en"
custom_dir = "overrides"
font.text = "Mona Sans"
font.code = "Source Code Pro"
logo = "assets/images/icon.png"
favicon = "assets/images/icon.png"
features = [
  "announce.dismiss",
  "content.action.edit",
  "content.action.view",
  "content.code.annotate",
  "content.code.copy",
  "content.tooltips",
  "navigation.footer",
  "navigation.indexes",
  "navigation.instant",
  "navigation.instant.prefetch",
  "navigation.instant.preview",
  "navigation.instant.progress",
  "navigation.tabs",
  "navigation.top",
  "navigation.tracking",
  "search.highlight",
  "search.share",
  "search.suggest",
  "toc.follow",
]

[project.theme.icon]
repo = "material/github"
link = "material/link-variant"

# Palette toggle for automatic mode
[[project.theme.palette]]
media = "(prefers-color-scheme)"
toggle.icon = "material/link"
toggle.name = "Switch to dark mode"

# Palette toggle for dark mode
[[project.theme.palette]]
media = "(prefers-color-scheme: dark)"
scheme = "slate"
primary = "black"
accent = "light blue"
toggle.icon = "material/toggle-switch-off-outline"
toggle.name = "Switch to light mode"

# Palette toggle for light mode
[[project.theme.palette]]
media = "(prefers-color-scheme: light)"
scheme = "default"
primary = "black"
accent = "light blue"
toggle.icon = "material/toggle-switch"
toggle.name = "Switch to system preference"

[project.plugins.meta]

[project.plugins.search]

[project.markdown_extensions.toc]
permalink = "#"

[project.markdown_extensions.attr_list]

[project.markdown_extensions.abbr]

[project.markdown_extensions.admonition]

[project.markdown_extensions.def_list]

[project.markdown_extensions.footnotes]

[project.markdown_extensions.md_in_html]

[project.markdown_extensions.tables]

[project.markdown_extensions.pymdownx.details]

[project.markdown_extensions.pymdownx.superfences]
custom_fences = [
  { name = "mermaid", class = "mermaid", format = "pymdownx.superfences.fence_code_format" },
]

[project.markdown_extensions.pymdownx.tasklist]
custom_checkbox = true

[project.markdown_extensions.pymdownx.snippets]
auto_append = ["includes/abbreviations.md", "includes/links.md"]

[project.extra.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"]

[[project.extra.social]]
icon = "fontawesome/brands/discord"
link = "https://discord.gg/jedJWCPAhD"
name = "PSModule on Discord"

[[project.extra.social]]
icon = "material/powershell"
link = "https://www.powershellgallery.com/profiles/PSModule.io"
name = "PSModule on the PowerShell Gallery"

[[project.extra.social]]
icon = "fontawesome/brands/github"
link = "https://github.com/PSModule/"
name = "PSModule on GitHub"