PieroDeTomi.DotNetMd
1.1.1
See the version list below for details.
dotnet tool install --global PieroDeTomi.DotNetMd --version 1.1.1
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local PieroDeTomi.DotNetMd --version 1.1.1
#tool dotnet:?package=PieroDeTomi.DotNetMd&version=1.1.1
nuke :add-package PieroDeTomi.DotNetMd --version 1.1.1
Summary
DotNetMd is a simple tool for generating Markdown docs from .NET assemblies.
This tool works both by reading assembly information through reflection and by reading XML documentation files generated by the compiler.
The idea behind this tool is to provide a simple way to generate documentation for .NET assemblies in a format that can be easily shared and read by developers... with a friendly eye to my favorite documentation tool of choice: Docusaurus 😃
Installation
DotNetMd is available as a NuGet Package, but it's mainly intended to be used as a dotnet tool.
It can be installed as a global tool by running the following command:
dotnet tool install --global PieroDeTomi.DotNetMd
Usage
Once installed, you can run the tool with the following command:
dotnetmd --config <path-to-config-file>
where <path-to-config-file> must be replaced with the path to the configuration file (see below for more information).
Configuration
The configuration is a JSON file that must follow this structure:
| Property Name | Type | Required | Description |
|---|---|---|---|
assemblies |
string[] |
Required | An array of paths to the assemblies to be documented |
outputPath |
string |
Optional<br /><br />Default: ".\docs" |
The path to the output directory where the Markdown files will be generated |
outputStyle |
"default" \| "microsoft" |
Optional<br /><br />Default: "default" |
The "theme" that will be used to generate the documentation.<br /><br />"default" will use a default/simpler documentation style, while "microsoft" will use an output style similar to the one used by the Microsoft Docs |
shouldCreateNamespaceFolders |
boolean |
Optional<br /><br />Default: true |
If true, the tool will create a folder for each namespace in the output directory, and will place the generated Markdown files in the corresponding folder.<br /><br />If false, all the files will be placed in the root of the output directory |
isDocusaurusProject |
boolean |
Optional<br /><br />Default: false |
If true, the tool will include Docusaurus front-matter in the Markdown files and will generate _category_.json files inside the folders, in order to make the integration in a Docusaurus project some kind of "copy/paste" process.<br /><br />If false, nothing will change in the generation process |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
This package has no dependencies.