DocFX alternatives and similar packages
Based on the "Documentation" category.
Alternatively, view DocFX alternatives based on common mentions on social networks and blogs.
-
SourceBrowser
Source browser website generator that powers http://referencesource.microsoft.com and http://source.roslyn.io -
F# Formatting
Tools for documenting F# and C# projects from F# Script files, Markdown documents and inline XML or Markdown comments
Get performance insights in less than 4 minutes
* 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?
Popular Comparisons
README
Generate your API documentation with DocFX
What's 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). For more information on DocFX v3, please visit the v3 working branch.
Quick Start
choco install docfx
docfx init -q
docfx docfx_project\docfx.json --serve
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 2019 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 |
---|---|
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.