Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Latest commit

 

History

History
History

README.md

Outline

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!

Morty Proxy This is a proxified and sanitized view of the page, visit original site.