DocFxMarkdownGen 0.1.6

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global DocFxMarkdownGen --version 0.1.6
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local DocFxMarkdownGen --version 0.1.6
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=DocFxMarkdownGen&version=0.1.6
nuke :add-package DocFxMarkdownGen --version 0.1.6

DocFxMarkdownGen

Generates documentation for a .NET library in Markdown intended for Docusaurus using docfx.

Installation

dotnet tool install -g DocFxMarkdownGen
# now installed as "dfmg", use with "dotnet dfmg" or just "dfmg" if tools are in PATH

Usage

By default dfmg takes it's config from config.yaml, you can override the file using the DFMG_CONFIG environment variable.

outputPath: /home/jan/whatever/docs/api
yamlPath: /home/jan/gen/api
  • outputPath is the path where the generated documentation will be placed, it is always wiped.
  • yamlPath is the path where the .yml files generated by docfx metadata are placed, probably the api directory where your docfx.json file is.
  • indexSlug is the slug of the index page, defaults to /api.

Example sites

For creating your own site, head to dfmg-template.

This project is still very new, if you find an issue in the markdown generated, please open an issue!

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
0.4.2 51 5/17/2024
0.4.1 961 7/27/2023
0.4.0 239 6/15/2023
0.3.1 152 5/17/2023
0.3.0 151 5/14/2023
0.2.1 158 5/6/2023
0.2.0 142 5/6/2023
0.1.7 138 5/4/2023
0.1.6 287 2/13/2023
0.1.5 412 1/8/2022
0.1.4 234 1/6/2022
0.1.3 232 1/5/2022
0.1.2 264 12/3/2021
0.1.1 946 12/1/2021