Documentation Site Template (MkDocs)¶
This page is about the .NET project template that scaffolds a MkDocs + Material documentation site: ConnectSoft.DocumentationTemplate, CLI short name connectsoft-documentation.
It is not the same as the Platform Documentation Template, which is a markdown outline for writing SaaS platform documentation pages inside this company site.
| Topic | Documentation Site Template (this page) | Platform Documentation Template |
|---|---|---|
| What it is | dotnet new scaffold → repo with mkdocs.yml, docs/, Python requirements.txt, sample Azure Pipelines |
Copy-paste structure for a platform doc page (sections, tone) |
| Output | A new repo or folder you build and host (Azure SWA, etc.) | Markdown content under ConnectSoft.CompanyDocumentation |
| Canonical CLI / parameters | ConnectSoft.Documentation — Documentation Template Parameters | N/A (editorial template only) |
When to use the MkDocs template¶
- A standalone documentation site for a product, library, or platform (build with
mkdocs build, host as static site). - Aligning with ConnectSoft plugins and pipeline samples (panzoom, exclude, log4brains ADRs).
Quick reference¶
- Install:
dotnet new installfrom the template repo or NuGet package ConnectSoft.DocumentationTemplate - Scaffold:
dotnet new connectsoft-documentation -hfor symbols (siteTitle,siteDescription,repoUrl,buildDefinitionNumber) - Local preview:
pip install -r requirements.txtthenmkdocs serve
Factory agents using the documentation-site-generator skill follow the same facts; see ConnectSoft.AI.SoftwareFactory.Documentation → Documentation Template + Documentation Site Generator agent specs.