Generates documentation for a .NET library in Markdown intended for Docusaurus using docfx.
dotnet tool install -g DocFxMarkdownGen
# now installed as "dfmg", use with "dotnet dfmg" or just "dfmg" if tools are in PATHBy 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/apioutputPathis the path where the generated documentation will be placed, it is always wiped.yamlPathis the path where the.ymlfiles generated bydocfx metadataare placed, probably theapidirectory where yourdocfx.jsonfile is.indexSlugis the slug of the index page, defaults to/api.
examples/discord-net-dfmg: example site done on Discord.Net- Log73
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!