Digitals.Docs.linux-arm64
0.1.0
See the version list below for details.
dotnet add package Digitals.Docs.linux-arm64 --version 0.1.0
NuGet\Install-Package Digitals.Docs.linux-arm64 -Version 0.1.0
<PackageReference Include="Digitals.Docs.linux-arm64" Version="0.1.0" />
<PackageVersion Include="Digitals.Docs.linux-arm64" Version="0.1.0" />
<PackageReference Include="Digitals.Docs.linux-arm64" />
paket add Digitals.Docs.linux-arm64 --version 0.1.0
#r "nuget: Digitals.Docs.linux-arm64, 0.1.0"
#:package Digitals.Docs.linux-arm64@0.1.0
#addin nuget:?package=Digitals.Docs.linux-arm64&version=0.1.0
#tool nuget:?package=Digitals.Docs.linux-arm64&version=0.1.0
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.
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.