Draft:Docfx
Submission declined on 20 January 2024 by KylieTastic (talk).
Where to get help
How to improve a draft
You can also browse Wikipedia:Featured articles and Wikipedia:Good articles to find examples of Wikipedia's best writing on topics similar to your proposed article. Improving your odds of a speedy review To improve your odds of a faster review, tag your draft with relevant WikiProject tags using the button below. This will let reviewers know a new draft has been submitted in their area of interest. For instance, if you wrote about a female astronomer, you would want to add the Biography, Astronomy, and Women scientists tags. Editor resources
|
Developer(s) | Microsoft,.NET Foundation |
---|---|
Initial release | 2017 |
Stable release | 2.74
/ November 30, 2023 |
Repository | github |
Written in | C#,JavaScript,TypeScript |
Operating system | any |
Platform | .NET Framework |
Type | Documentation generator |
License | MIT |
Website | github |
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]
- ^ "Documentation in a DevOps World". 14 April 2017.
- in-depth (not just passing mentions about the subject)
- reliable
- secondary
- independent of the subject
Make sure you add references that meet these criteria before resubmitting. Learn about mistakes to avoid when addressing this issue. If no additional references exist, the subject is not suitable for Wikipedia.