Digitals.Docs.linux-arm64
0.4.3
dotnet add package Digitals.Docs.linux-arm64 --version 0.4.3
NuGet\Install-Package Digitals.Docs.linux-arm64 -Version 0.4.3
<PackageReference Include="Digitals.Docs.linux-arm64" Version="0.4.3" />
<PackageVersion Include="Digitals.Docs.linux-arm64" Version="0.4.3" />
<PackageReference Include="Digitals.Docs.linux-arm64" />
paket add Digitals.Docs.linux-arm64 --version 0.4.3
#r "nuget: Digitals.Docs.linux-arm64, 0.4.3"
#:package Digitals.Docs.linux-arm64@0.4.3
#addin nuget:?package=Digitals.Docs.linux-arm64&version=0.4.3
#tool nuget:?package=Digitals.Docs.linux-arm64&version=0.4.3
Digitals.Docs
dt-docs builds and checks a project docs site: Docusaurus with sections, search and optional Entra ID sign-in from one docs-settings.yml, keys that link any page to a spot on another, and checks of every page's front matter, links and headings. 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 lint # settings, pages and keys; exit 1 on any finding
dotnet dt-docs build # lint, then the site and its access config into build/
| Command | Does |
|---|---|
init [<dir>] |
Writes docs-settings.yml, 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. port in docs-settings.yml sets the default |
lint |
Fails on a docs-settings.yml mistake, a missing homepage, front matter missing a field or with a wrong value, a description over 160 characters, a page name that isn't lowercase, a broken link or image, an image without alt text, a skipped heading level, a TODO in a page out of draft, a key that isn't URL safe or is defined twice, or a :ref to a key no page defines |
pages |
Prints every page's path, title and description, by section |
find [<key>] |
Prints where a key is defined and its /go link, or lists the keys starting with what you give it |
build |
lint, then the static site with search into build/, with staticwebapp.config.json requiring sign-in, or with no sign-in under auth: mode: none. 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-settings.yml 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.