DocFX Alternatives - .NET Documentation

Popularity

8.1

Growing

Activity

9.0

Declining

Stars 1,807

Watchers 135

Forks 467

Last Commit about 2 months ago

Code Quality Rank: L2

Monthly Downloads: 1,053

Programming language: C#

License: Microsoft Reciprocal License

Tags: Documentation

DocFX alternatives and similar packages

Based on the "Documentation" category

Swashbuckle

9.0 1.6 L4 DocFX VS Swashbuckle

Seamlessly adds a swagger to WebApi projects!
Sandcastle

7.6 6.0 L1 DocFX VS Sandcastle

Sandcastle Help File Builder similar to NDoc
Consul.NET

6.0 0.0 DocFX VS Consul.NET

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

5.4 7.0 L2 DocFX VS SourceBrowser

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

5.0 6.6 DocFX VS F# Formatting

Tools for documenting F# and C# projects from F# Script files, Markdown documents and inline XML or Markdown comments
SharpDox

3.4 0.0 L4 DocFX VS SharpDox

A c# documentation tool
DocNet

3.3 2.0 L1 DocFX VS DocNet

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

* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest. Visit our partner's website for more details.

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

Add another 'Documentation' Package

Popular Comparisons

README

Generate your API documentation with DocFX

What is it

DocFX makes it extremely easy to generate your developer hub with API reference, landing page, and how-to.

What's next

Check out the road map of DocFX [here](Roadmap.md).

NOTE: For more information on DocFX v3, please visit the v3 working branch.

How to use

Option 1: install DocFX through chocolatey package: choco install docfx -y.
Option 2: install DocFX through nuget package: nuget install docfx.console, docfx.exe is under folder docfx.console/tools/.
Option 3: play DocFX inside Visual Studio: create a Class Library (.NET Framework) project, Manage Nuget Packages to install docfx.console nuget package on the project, Build to create the generated website under folder _site.

For more information, please refer to Getting Started.

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).

.NET Foundation

DocFX is supported by the .NET Foundation.

DocFX Project

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

How to build from source code

Prerequisites

Visual Studio 2017 with .NET Core cross-platform development toolset
Node.js

Steps

Option 1: Run build.cmd under DocFX code repo.
Option 2: Open docfx.sln under DocFX code repo in Visual Studio and build docfx.sln.

Build Status

master	dev

Packages

Chocolatey	Nuget	Nightly Build

Running Status

Windows with VS2017	Ubuntu Linux with Mono

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

DocFX

Tools for building and publishing API documentation for .NET projects