repowisedotnet/docfx

dotnet / docfx

Static site generator for .NET API documentation.

C#★ 4,447
Use in your agentAsk this codebase

github.com/dotnet/docfxIndexed at 96d08d8Up to date with upstream

What is docfx?

docfx is a static site generator for .NET API documentation. It builds technical documentation sites from landing pages, Markdown, .NET API reference documentation, REST API documentation, YAML-structured sources, templates, and media. docfx is primarily written in C# and also includes JavaScript and TypeScript.

Written by a model from the README and the source

1,462 files and 8,846 symbols in 6 modules, led by C# (822 files) and JavaScript (37).

Start reading

Code health

9.1out of 10Excellent

This codebase scores 9.1 out of 10 for code health, which we rate excellent. It also scores maintainability 9.1 and static performance 9.9 out of 10. The three are scored separately and never blended into one number. Risk is concentrated, as it usually is: 3 of 1,462 files are git hotspots, and they average 7.0 — which is where the fixes pay off most.

Full health report

On the leaderboards:#3 of 10 C# repos

Use dotnet/docfx in your agent

Point Claude Code, Cursor, Codex or VS Code at this repository. Your agent gets the index this page is built from: cited answers, callers, history and health for any file.

  1. 1.In Claude, open Customize → Connectors, click +, then Add custom connector. On a Team or Enterprise plan an owner adds it first under Organization settings → Connectors.
  2. 2.Paste the server URL below as the Remote MCP server URL, then click Add.
  3. 3.Click Connect. A Repowise sign-in window opens. Approve access.
  4. 4.Repowise's tools are now available in your Claude chats.

Connect with one click. Sign in with Repowise (OAuth), no API key to copy. Works in Claude on the web, desktop, and mobile.

Docs
bash
https://api.repowise.dev/mcp/dotnet/docfx
Editors need an API key: sign in to create one.Sign in to connect

This repo is public, so anyone with a Repowise account and an API key can connect.

Try asking

  • get_overview()
  • get_answer("how is docfx put together?")
  • get_why("why is docfx structured this way?")

Explore docfx

Key features of docfx

  • docfx builds technical documentation sites with landing pages and Markdown.
  • docfx generates .NET API reference documentation.
  • docfx supports REST API documentation.
  • docfx consumes YAML-structured sources, managed reference metadata, templates, and related media.
  • docfx can serve a generated sample site locally during a build.

How dotnet/docfx works

docfx accepts build inputs through its command-line entry layer in src/docfx. The build pipeline parses, merges, resolves, and renders Markdown, YAML-structured sources, managed reference metadata, templates, and media. src/Docfx.Build/ApiPage/ApiPage.cs handles API page generation within the core build engine. Plugin-driven processors perform document-processing stages and connect input handling to rendering. Markdig processes Markdown, while schema-driven stages process structured documentation data. The templates directory supplies template packages and styling assets for the generated site, which includes HTML or Markdown artifacts and supporting indexes.

The codebase has 1,462 files and 8,846 symbols in 6 modules, led by C#, JavaScript and TypeScript. Code health is 9.1 out of 10, rated excellent.

Getting started with docfx

  1. Install docfx as a global tool.
    dotnet tool install -g docfx

Commands copied from the README

dotnet/docfx FAQ

What is docfx?

docfx is a static site generator for .NET API documentation. It builds technical documentation sites with landing pages, Markdown, .NET API reference documentation, and REST API documentation.

How does docfx work?

docfx parses, merges, resolves, and renders documentation inputs through a build pipeline. The pipeline uses Markdig, schema-driven processing, plugin-driven processors, and templates to produce a documentation site.

How do I install docfx?

docfx installs as a global .NET tool with dotnet tool install -g docfx. A local site can be initialized and served with docfx init -y and docfx build docfx_project\docfx.json --serve.

What language is docfx written in?

docfx is primarily written in C#. The repository also includes JavaScript and TypeScript.

How is the docfx code organized?

docfx organizes its main implementation in src, tests in test, templates in templates, samples in samples, and documentation in docs. src/docfx provides the command-line entry layer, while src/Docfx.Build contains core build components.

Who is docfx for?

docfx is for people building technical documentation sites. It supports landing pages, Markdown, .NET API reference documentation, and REST API documentation.

What license does docfx use?

docfx uses the MIT license.

The summary, features and answers on this page are written by a model from the README and the source, and refreshed with each index.

About this page

Get a page like this for your own codebase

Repowise built this map of dotnet/docfx from its source and git history. It parses every symbol, draws the dependency graph, scores each file's health from complexity, duplication, coverage and churn, finds hotspots and owners in the history, and writes documentation for every module. Your coding agent reads the same index over MCP, so its answers cite real files.

Index your repo freeSee how Repowise worksFree for 2 public repos, with a page like this one.

Prefer local? pip install repowise && repowise init indexes your own checkout, no account needed.