question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

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

See original GitHub issue

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.

Issue Analytics

  • State:open
  • Created 7 years ago
  • Reactions:64
  • Comments:24 (12 by maintainers)

github_iconTop GitHub Comments

40reactions
MathewSachincommented, Sep 9, 2016

@chenkennt I want DocFX to extract xml documentation from source code and augment my markdown files into it.

18reactions
open-collarcommented, Jun 27, 2019

This would be really useful as a means of posting generated documentation in Azure DevOps (as a “Code Wiki”). For that reason I would support the standards recommended by them here which includes the standard DaringFireball standard and the GitHub Extensions.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to display HTML content in github README.md?
3 Answers. Github's markdown interpreter can include HTML. However, there is only so much you can do in HTML. I would suggest checking...
Read more >
Markdown output - CKEditor 5 Documentation
CKEditor 5 can be configured to output Markdown instead of HTML. Markdown is a lightweight markup language that you can use to add...
Read more >
Guide to writing on Readme.md (.markdown)file for GitHub ...
Markdown can be converted into other formats (such as HTML) and has been incorporated into many things. It's the standard format for ReadMe...
Read more >
Markdown | IntelliJ IDEA Documentation
IntelliJ IDEA recognizes Markdown files, provides a dedicated editor with highlighting, completion, and formatting, and shows the rendered HTML ...
Read more >
Markdown editing with Visual Studio Code
Working with Markdown files in Visual Studio Code is simple, straightforward, and fun. Besides VS Code's basic editing, there are a number of...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found