DG is a .NET Core console application for converting the XML-based documentation of .NET code into a comprehensive API help. DG can generate documents in both Markdown and HTML formats.
Simply run DG and pass your assembly file as a command-line argument to it. The XML document should be in the same directory and have the same file name as the assembly file.
Usage: <dotnet> <path-to>/dg.dll [OPTIONS] <path-to-assembly>+
Options:
-m, --markdown Generates documents in markdown (default)
-x, --html Generates documents in HTML
-s, --style=URL Custom stylesheet URL for HTML documents
-i, --index=FILENAME Index document name (default _toc.<assembly>)
-d, --outdir=PATH Base output directory (default cwd)
-f, --flat All formats in one folder (default off)
-h, --help Shows this message and exit
To make generating documents as part of the build process, add the following lines to your project file:
<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command="dotnet {path-to}/dg.dll --markdown --html --outdir=$(ProjectDir)/docs $(TargetPath)" />
</Target>Don't forget to enable generating the XML document in your project.
DG supports all standard and recommended tags for documentation comments.
<c><code><example><exception><include><list><para><param><paramref><permission><remarks><returns><see><seealso><summary><typeparam><typeparamref><value>
Additionally, it recognizes the following Sandcastle's custom tags:
To see how documents generated by DG look like, please follow the link:
Those documents are the actual documentation of the Asserted.Utils NuGet package.
If you have ideas to improve the functionality or code quality of this program, please don't hesitate to share it here by making a pull request.