Home > Software > Office > Documentation > DocFX

DocFX logo

Details

Package ID
docfx
Version
2.35.4
Downloads
30973
Website
http://dotnet.github.io/docfx/

Summary

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

Description

DocFx is a documentation generation tool for API reference and Markdown files!

DocFX is an API documentation generator for .NET, and currently it supports C# and VB. 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 servers (for example, github.io). Also, DocFX provides you the flexibility to customize the layout and style of your website through templates. If you are interested in creating your own website with your own styles, you can follow how to create custom template to create custom templates.

Features

  • Website from Source Code and Markdown - DocFX generates Documentation directly from source code (.NET, RESTful API, JavaScript, Java, etc…) and Markdown files.
  • Run Everywhere - DocFX runs on Linux, macOS, and Windows. The generated website can be deployed to any web host with no additional configurations, e.g. Github Pages, Azure Websites…
  • Easy Customization - DocFX provides a flexible way to customize templates and themes easily.

Comments

Loading comments...