Draft:Docfx

From Wikipedia, the free encyclopedia
docfx
Developer(s)Microsoft,.NET Foundation
Initial release2017; 7 years ago (2017)
Stable release
2.74 / November 30, 2023; 5 months ago (2023-11-30)
Repositorygithub.com/dotnet/docfx
Written inC#,JavaScript,TypeScript
Operating systemany
Platform.NET Framework
TypeDocumentation generator
LicenseMIT
Websitegithub.com/dotnet/docfx

docfx is a documentation generator from Microsoft. It automatically produces HTML and PDF documentation out of reflection information of .NET assemblies and XML documentation comments found in the source code of these assemblies. Other documentation can be added using Markdown and YAML.

Overview[edit]

The software was first published in 2017 as successor to Sandcastle (Software) [1]. docfx generates and converts Markdown and other inputs to cross-linked YAML files. In a second pass the documentation is compiled to static HTML websites and PDF. Diagrams and charts can be embedded using Mermaid-JS. Math expressions are supported by LaTeX inspired syntax extensions to Markdown.

See also[edit]

References[edit]

  1. ^ "Documentation in a DevOps World". 14 April 2017.

External links[edit]

References[edit]