Digitals.Docs
0.1.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet tool install --global Digitals.Docs --version 0.1.0
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local Digitals.Docs --version 0.1.0
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=Digitals.Docs&version=0.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package Digitals.Docs --version 0.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Digitals.Docs
dt-docs builds and checks a project docs site: Docusaurus with sections, search and Entra ID sign-in from one docs.json, rule IDs linked to their definitions, and a check that MANIFEST.md lists every page. Bun and the site ship inside the package, so a project needs only the .NET SDK.
dnx Digitals.Docs init acme-docs # a new project docs repo; asks for what you leave out
cd acme-docs && dotnet tool restore
dotnet dt-docs dev # the site with live reload
dotnet dt-docs check # docs.json, MANIFEST.md and rule IDs; exit 1 on any finding
dotnet dt-docs build # check, then the site and its sign-in config into build/
| Command | Does |
|---|---|
init [<dir>] |
Writes docs.json, the tool manifest, MANIFEST.md, a glossary, one folder per section, AGENTS.md and a GitHub Actions or Azure Pipelines file. Never overwrites a file |
dev |
Serves the site with live reload. Options go to Docusaurus, such as --port 3001 |
check |
Fails on a docs.json mistake, a page missing from MANIFEST.md, a rule ID defined twice, or a citation of an ID nobody defines |
build |
check, then the static site with search into build/, with staticwebapp.config.json requiring sign-in. A broken link fails it |
serve |
Serves the last build |
new <kind> <page> |
A page from a template: domain, systems, feature, adr or page |
guide [<topic>] |
How to write each kind of page |
On GitHub Actions and Azure Pipelines, findings print as pull request annotations with their file and line; --format text|github|azure overrides that.
A minor or patch release never needs a change to docs.json or a page. The full guide, the example project and the release notes are at github.com/Digitals-OYT-Ltd/docs-conventions.
There are no supported framework assets in this package.
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.