Skip to content

Support output as Markdown instead of html, for example, for github readme.md #684

Description

@MathewSachin

DocFX does a great job in building static websites.
But, I want to know if there is a way to export the files in Markdown.
It would then be easy to put up on GitHub wikis or GitBook.

And by that I mean that I don't require features like search, Affix, Breadcrumb, navbar, footer, etc.

Here's what I tried:

  • Renamed *.html.primary.* files to *.md.primary.*
  • Modified partials and templates from html to markdown.
  • Removed unnecessary features.

That was a good progress but with two major problems:

  1. Markdown in conceptual documentation was getting converted to html. I really need to prevent this. Trying to add the *.md files to resources failed resulting in unresolved links.
  2. Xml Documentation was being converted to html.

So, finally it seems that I want some way to convert that output html to markdown.

Any help is appreciated and BTW thank you for this awesome software.

Metadata

Metadata

Assignees

No one assigned

    Labels

    dotnetGenerate .NET API reference docstemplateThe stock site template

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions