Popularity

8.8

Growing

Activity

7.8

Declining

Stars 3,023

Watchers 155

Forks 716

Last Commit 6 days ago

Code Quality Rank: L2

Programming language: C#

License: MIT License

Tags: Documentation

Latest version: v2.56.5

DocFX alternatives and similar packages

Based on the "Documentation" category.
Alternatively, view DocFX alternatives based on common mentions on social networks and blogs.

MkDocs

9.8 8.4 L5 DocFX VS MkDocs

Project documentation with Markdown.
Swashbuckle

8.7 0.0 L4 DocFX VS Swashbuckle

Seamlessly adds a swagger to WebApi projects!

Less time debugging, more time building

Scout APM allows you to find and fix performance issues with no hassle. Now with error monitoring and external services monitoring, Scout is a developer's best friend when it comes to application development.

Promo scoutapm.com

Sandcastle

7.8 4.8 L1 DocFX VS Sandcastle

Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.
Consul.NET

6.3 0.0 DocFX VS Consul.NET

.NET API for Consul (http://www.consul.io/)
SourceBrowser

6.2 6.2 L2 DocFX VS SourceBrowser

Source browser website generator that powers http://referencesource.microsoft.com and http://sourceroslyn.io
F# Formatting

5.2 7.8 DocFX VS F# Formatting

F# tools for generating documentation (Markdown processor and F# code formatter)
DocNet

3.7 0.0 L1 DocFX VS DocNet

Your friendly static documentation generator, using markdown files to build the content.
SharpDox

3.5 0.0 L4 DocFX VS SharpDox

A c# documentation tool

* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.

Do you think we are missing an alternative of DocFX or a related project?

Add another 'Documentation' Package

Popular Comparisons

README

Generate your documentation with DocFX

DocFX makes it extremely easy to generate your developer hub with a landing page, API reference, and conceptual documentation, from a variety of sources.

Quickstart

Install DocFX and deploy a sample documentation web site:

Open a console.
Enter the following commands to install DocFX and build/deploy a sample site:

   choco install docfx
   docfx init -q
   docfx docfx_project\docfx.json --serve

Go to https://localhost:8080 to view the sample DocFX site.

For more information, refer to Getting Started.

DocFX project

Build the DocFX solution

To build the DocFX binaries from the Visual Studio solution:

Install Visual Studio 2019 with .NET Core cross-platform development toolset
Install Node.js
Build the solution using one of the following options:

Option 1: Console
- Open a DOS console and navigate to your DocFX clone subdirectory.
- Run build.cmd.
Option 2: Visual Studio
- Open a PowerShell console and navigate to your DocFX clone subdirectory.
- Run ./UpdateTemplate.ps1 to generate the template files required by the Visual Studio solution.
- Open the docfx.sln solution in your DocFX clone subdirectory from Visual Studio and build it.

Build Status

dev is the default branch accepting Pull Requests. It releases a package daily. main branch is the release branch.

main	dev

Install packages

Chocolatey	Nuget

Running Status

Windows with VS2017	Ubuntu Linux with Mono

How to Contribute

For new comers, you can start with issues with help-wanted. Check out the [contributing](.github/CONTRIBUTING.md) page to see the best places to log issues and start discussions.

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

License

DocFX is licensed under the [MIT license](LICENSE).

DocFX is supported by the .NET Foundation.

*Note that all licence references and agreements mentioned in the DocFX README section above are relevant to that project's source code only.

DocFX

Static site generator for .NET API documentation.