DocFX alternatives and similar packages
Based on the "Documentation" category
* 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?
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.
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.exeis 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.consolenuget package on the project, Build to create the generated website under folder
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.
DocFX is licensed under the [MIT license](LICENSE).
DocFX is supported by the .NET Foundation.
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
- Option 1: Run
build.cmdunder DocFX code repo.
- Option 2: Open
docfx.slnunder DocFX code repo in Visual Studio and build docfx.sln.
|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.