Documentation Site Template Parameters¶

This page is the canonical reference for ConnectSoft.DocumentationTemplate (dotnet new connectsoft-documentation). Other docs should link here instead of duplicating tables.

Template parameters vs pipeline variables¶

Template parameters (dotnet new ...) come from .template.config/template.json and control string replacements in the scaffold (site title, description, repo URL for edit links, build badge placeholder, copyright year token).
Azure Pipelines variables in azure-pipelines-documentation.yml (artifact names, pools, approvals) are not dotnet new switches. Configure them in Azure DevOps after you push the generated repo.

Identity and install¶

Item	Value
Package identity	`ConnectSoft.DocumentationTemplate`
Short name	`connectsoft-documentation`
Source name	`ConnectSoft.DocumentationTemplate` (replaced by `-n` / `--name`)

Install the template from a clone or package:

dotnet new install <PATH_TO_DOCUMENTATION_TEMPLATE_REPO>
# or
dotnet new install ConnectSoft.DocumentationTemplate   # when feed is configured

Verify flags: dotnet new connectsoft-documentation -h

Host mapping (CLI long/short names) is in .template.config/dotnetcli.host.json in the template repo.

Symbols¶

Symbol	Type	Default	CLI (long)	Short	Description
`siteTitle`	string	`ConnectSoft Docs`	`--site-title`	`-title`	`site_name` / branding in `mkdocs.yml`.
`siteDescription`	string	(see template)	`--site-description`	`-description`	Meta description in `mkdocs.yml`.
`repoUrl`	string	Azure DevOps URL to ConnectSoft.Documentation sample	`--repo-url`	`-repo`	Repository URL for Material “edit” links and `repo_url` in `mkdocs.yml`—override for your real repo.
`buildDefinitionNumber`	string	`""`	`--build-definition-number`	`-bdn`	Optional string for CI badges or placeholders (same pattern as other ConnectSoft templates).
`currentYear`	generated	(now, `yyyy`)	—	—	Replaces `1975` placeholder in `mkdocs.yml` copyright line at scaffold time.

There are no boolean feature toggles in this template.

Standard `dotnet new` parameters¶

Parameter	CLI	Notes
Output name	`-n`, `--name`	Replaces `ConnectSoft.DocumentationTemplate` in paths and project names.
Output folder	`-o`, `--output`	Where to create the scaffold.

Copyright year (`1975` placeholder)¶

The template ships copyright: ... 1975 ... in mkdocs.yml so the currentYear generator can substitute the real year when the template runs. If you copy files without dotnet new, replace 1975 manually.

Python / MkDocs prerequisites¶

Generated sites need the packages listed in the template’s requirements.txt: Material for MkDocs, mkdocs-panzoom-plugin, and mkdocs-exclude (see template mkdocs.yml plugins). Mermaid uses pymdownx.superfences with Material, not mkdocs-mermaid2-plugin.

Template output vs this documentation site¶

Topic	DocumentationTemplate scaffold	ConnectSoft.Documentation (this site)
Content folder	`docs/`	`Docs/` (capital D)
`use_directory_urls`	default (typically `true`)	`false` for predictable links
Nav size	Starter pages	Full ecosystem nav

Behavior is the same stack (MkDocs Material); paths and nav differ by design.