Skip to content

Building the docs site

Ethan Lafrenais edited this page Jan 31, 2023 · 1 revision

The documentation site is written using docfx and lives in the docs directory.

Building the site doesn't require the docfx CLI to be installed, since this is done via the Microsoft.DocAsCode.App NuGet package:

# Must be ran from within the docs directory!
cd docs
# Outputs documentation site to docs/_site
dotnet run --project build

Once the site is built, it can be previewed by using the docfx CLI (as shown below) or by using your static site server of choice:

docfx serve _site

Additionally, the site can be viewed straight from the file system by modifying docfx.json to build with the statictoc template (however, this build takes significantly longer):

# docs/docfx.json
{
    ...
-   "template": ["default", "memberpage", "templates/discore"],
+   "template": ["default", "statictoc", "memberpage", "templates/discore"],
    ...
}
Clone this wiki locally