DocFX
dotnet-ci-pipelines
Our great sponsors
| DocFX | dotnet-ci-pipelines | |
|---|---|---|
| 18 | 1 | |
| 3,880 | 20 | |
| 1.5% | - | |
| 9.8 | 0.0 | |
| 4 days ago | over 1 year ago | |
| C# | C# | |
| MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
DocFX
-
TSDocs.dev: type docs for any JavaScript library
This is a better looking version of what Java and C# have had for a long time (kudos to the author for that!), is that the inspiration for this tool?
https://docs.oracle.com/javase/8/docs/technotes/tools/window...
https://dotnet.github.io/docfx/
I saw the author mentioned in another comment that they found themselves peeping inside type declaration files "too often". While I do often use sites generated by the above tools to discover new API's that suit my needs, diving into the actual code using a good decompiler is still my first move, as it is often cheaper than seeking out the documentation online, and it will show me the actual implementation as well. So in my opinion there is no shame in looking inside the declaration files!
-
Use Case Driven Development with Low-Code
Tools like DocFx provide the ability to display the programmable functions in HTML pages. They are used with the following commands in the docfx folder:
-
Anybody know if there's a library for the doc engine that MS Docs/Learn uses?
AFAIK they use https://github.com/dotnet/docfx which can be too heavy for your case. We use mdBook for internal documentation (plain .md with mermaid plugin) and then serve it at docs.yourdevenv.com.
- Is there a simple way to auto-generate a wiki / documentation for project code that pulls from comments or <summary> tags?
-
What the latest tool to generate website docs from /// summary comments?
DocFX is a nice solution.
-
How to build a solution like docs.microsoft.com
It uses DocFX
-
Comments in Javascript
Some of the standard and well-maintained Tools for Comments are JSDoc for Javascript, DocFx for .NET, and JavaDoc for Java.
-
What Does Microsoft Use to Create their KB Articles?
Actually, we use it for OptiTune, it's called "docfx" https://dotnet.github.io/docfx/
-
Library / Codebase Documentation - Multiple aggregated libraries - How to create? DocFx does not support this?
We would really prefer to use a somewhat generic pre-made tool for this (such as DocFX) compared to rolling our own solution. We can roll our own solution... But would prefer not to so that we can minimize development and maintenance overhead.
dotnet-ci-pipelines
-
dotnet-ci-pipelines
[ ] GitHub Actions
What are some alternatives?
Sandcastle - Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.
EventSourcing.NetCore - Examples and Tutorials of Event Sourcing in .NET
MkDocs - Project documentation with Markdown.
gitlab-ci-example-dotnetcore
Swashbuckle - Seamlessly adds a swagger to WebApi projects!
Entity Framework - EF Core is a modern object-database mapper for .NET. It supports LINQ queries, change tracking, updates, and schema migrations.
DocNet - Your friendly static documentation generator, using markdown files to build the content.
practical-aspnetcore - Practical samples of ASP.NET Core 8.0, 7.0, 6.0, 5.0, 3.1, 2.2, and 2.1,projects you can use. Readme contains explanations on all projects.
SharpDox
Coravel - Near-zero config .NET library that makes advanced application features like Task Scheduling, Caching, Queuing, Event Broadcasting, and more a breeze!
F# Formatting - F# tools for generating documentation (Markdown processor and F# code formatter)
Stryker.NET - Mutation testing for .NET core and .NET framework!