{"repo":"Jan0660/DocFxMarkdownGen","free":true,"listed":false,"github":"https://github.com/Jan0660/DocFxMarkdownGen","clone":"git clone https://github.com/Jan0660/DocFxMarkdownGen.git","description":"Docusaurus Markdown generator using DocFX.","language":"C#","stars":36,"topics":["markdown","documentation","docfx","csharp","dotnet","docusaurus","docusaurus2"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"DocFxMarkdownGen Generates documentation for a .NET library in Markdown intended for Docusaurus using docfx. Installation Usage By default dfmg takes it's config from config.yaml , you can override the file using the DFMG CONFIG environment variable. - outputPath is the path where the generated documentation will be placed, it is always wiped. Can be overriden with the DFMG OUTPUT PATH environment variable. - yamlPath is the path where the .yml files generated by docfx metadata are placed, probably the api directory where your docfx.json file is. Can be overriden with the DFMG YAML PATH environment variable. - indexSlug is the slug of the index page, defaults to /api . - typesGrouping read below. - rewriteInterlinks set this to true if encountering issues with links when building the site. Types grouping Example: If type grouping is enabled, types in namespaces with a number of types greater than or equal to minCount will be grouped by Class , Struct , Interface , Enum and Delegate in the sidebar. Newlines Example: - brNewline is the string that will be used to replace tags in the generated markdown. - forceNewline if true, will replace all newlines( \\n ) with forcedNewline . Example sites - RCaron - (outdated) examples/discord-net-dfmg : example site done on Discord.Net - (outdated) Log73 For creating your own site, head to: - dfmg-template for a minimalish example - dfmg-template2 for a more complete example with versioned docs and CI examples for deploying to GitHub Pages ","default_branch":null,"files":null,"tree":[],"storefront":"/r/Jan0660","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Jan0660/DocFxMarkdownGen/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}