DocFX is an extensible and scalable static documentation generator. It generates API reference documentation from triple-slash comments in your source code. It also allows you to use Markdown files to create additional topics such as tutorials and how-tos, and to customize the generated reference documentation. DocFX builds a static HTML website from your source code and Markdown files, which can be easily hosted on any web server.
DocFX can produce documentation from source code (including C#, F#, Visual Basic, REST, JavaScript, Java, Python and TypeScript) as well as raw Markdown files.
This is free and open source software.
Key Features
- Integration with your source code. You can click “View Source” on an API to navigate to the source code in GitHub (your source code must be pushed to GitHub).
- Generated static website can be deployed to any host such as GitHub Pages or Azure Websites with no additional configuration.
- Integration with Visual Studio.
- Markdown extensions with DocFX Flavored Markdown which is 100% compatible with GitHub Flavored Markdown(GFM) with some useful extensions, including file inclusion, code snippet, cross reference, and yaml header.
- Provides a flexible way to customize templates and themes.
- Cross-platform support – runs under Linux, macOS, and Windows.
Website: dotnet.github.io/docfx
Support: Tutorials
Developer: Microsoft Corporation
License: MIT License
DocFX is written in C#. Learn C# with our recommended free books and free tutorials.
Related Software
| C# Static Site Generators | |
|---|---|
| DocFX | Extensible and scalable static documentation generator |
| BookGen | CLI toolchain for writing books and documentation in Markdown |
| GrazeDocs | Source static documentation generator. Content created with Markdown |
| BlazorStatic | Craft static websites |
| AspNetStatic | Transform ASP.NET Core into a static site generator |
| Record Collector | .NET 6.0 static site toolkit |
Read our verdict in the software roundup.
 Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more. Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form. |