Codebelt
v2.81.0

DocFX Builder

Build DocFX documentation through the same containerized environment used across the Codebelt ecosystem.

Build and Delivery Containerized DocFX build environment 1,335 pulls 0 stars Updated 2026-09-27
Open on Docker Hub View source Use related skill

What it is

DocFX Builder is not DocFX itself. It is Codebelt's Docker image for delegating a repository's DocFX build to a shared, versioned environment. A consuming repository supplies its DocFX metadata and content, then lets the container provide the build toolchain and shared templates.

The image includes the DocFX default and modern templates plus the Codebelt ms-style compatibility overlay. That overlay shapes Codebelt API reference sites toward a Microsoft Learn-style reading surface with type-first headings, definition facts, type and member tables, responsive light and dark styling, and a layout that keeps API pages readable on wide and narrow screens.

Why choose it

Use this Tool when a repository should build documentation the same way every time without repeating DocFX setup in every consuming project. The shared image keeps DocFX tooling, template assets, and the Codebelt documentation shell together, which reduces drift between library families.

The practical value is consistency. A repository can keep its generated YAML, Markdown, TOCs, overwrite files, filters, and source-link metadata while adopting the shared template surface. Local template overrides remain possible, but the default Codebelt API presentation comes from one maintained environment.

What it gives you

  • A containerized DocFX build environment that consuming repositories can call from their documentation Dockerfile.
  • The Codebelt ms-style overlay for API reference pages that should present a consistent documentation experience.
  • Shared template versioning so visual and structural documentation changes can be rolled through the ecosystem deliberately.
  • A local-first Docker feedback loop where a locally built image can be used before pulling the published one.

How it fits the SDLC

DocFX Builder sits in the documentation and release part of the lifecycle. It gives the build a repeatable environment for producing API reference output, while repository-specific documentation content stays in the consuming project.

This is different from the .NET DocFX Digest skill. The Tool provides the documentation build environment. The Skill performs the engineering practice of inspecting APIs, repairing documentation, updating examples, and verifying that the DocFX surface stays useful.

Getting started

Use the Docker image from Docker Hub in the documentation build for a repository that already owns its DocFX content. Add the repository content to the image's expected DocFX workspace, then configure docfx.json to include the shared template path:

{
  "build": {
    "template": [
      "default",
      "modern",
      "templates/ms-style"
    ]
  }
}

For Microsoft Learn-style type pages, the source README also describes adding memberLayout: "separatePages" to managed-reference metadata entries. Keep detailed DocFX configuration in the source repository where it can move with the image.