Skip to content

Documentation Site Template Overview

The ConnectSoft Documentation Site Template (ConnectSoft.DocumentationTemplate) scaffolds a MkDocs project using the Material for MkDocs theme, optional log4brains ADRs, sample Azure Pipelines YAML, and Azure Static Web Apps config—suitable for product docs, API guides, and architecture narratives.

When to use it

  • Greenfield technical documentation sites for a repo, product, or platform
  • Teams that want one command (dotnet new connectsoft-documentation) plus Python pip install -r requirements.txt for local preview
  • Documentation that should stay aligned with ConnectSoft conventions (theme, extensions, pipeline shape)

What you get

  • mkdocs.yml with Material, search, panzoom, exclude, and pymdownx (including Mermaid via superfences)
  • docs/ tree: home, architecture, use cases, API reference stub, tutorials, includes/, sample ADR under docs/adr/
  • package.json scripts for log4brains ADR preview/build
  • azure-pipelines-documentation.yml sample (build MkDocs, build ADRs, merge into site/, publish artifact)
  • staticwebapp.config.json for Azure Static Web Apps
  • .sln for packaging or editor ergonomics

Canonical parameters

Full CLI and symbol reference: Parameters.