Markdown - tips and tools

• Tutorials
• Official logo
• Tools
  • markdown-link-check
  • Converters
    • CSV to markdown
    • Google doc to markdown
    • HTML to markdown
    • markdown to HTML
    • PDF to MD
    • URL to markdown
    • XLS to markdown
  • Markdown-css
  • Mermaid
  • lorem-markdownum
  • markdown-lint
  • Generate a mindmap from a bullet list
  • Convert a folder to an HTML site
    • Installation
  • Presentation tool (slideshows)
    • Reveal-md
    • Remark
  • Table generator
  • Limedocs Wiki converter
• Other tools, not directly markdown
  • Diagram tool
• License

Tutorials

Author guide on github

Official logo

https://github.com/dcurtis/markdown-mark

Use this mark to identify Markdown. https://dcurt.is/the-markdown-mark.

Tools

markdown-link-check

https://github.com/tcort/markdown-link-check

Checks that all of the hyperlinks in a markdown text to determine if they are alive or dead.

The tool has a CLI mode so it's possible to scan one file markdown-link-check ./README.md or an entire folder find . -name \*.md -exec markdown-link-check {} \; (find will search any .md file and run the tool for each retrieved file).

Converters

CSV to markdown

https://github.com/cavo789/marknotes_csv2md

CSV to markdown converter.

• Online converter

Google doc to markdown

https://github.com/evbacher/gd2md-html

Convert a Google Doc to Markdown or HTML. This free Docs add-on converts a Google Doc to simple Markdown and/or HTML.

HTML to markdown

https://github.com/cavo789/marknotes_html2md

HTML to markdown converter.

• Online converter

markdown to HTML

https://github.com/cavo789/marknotes_md2html

Markdown to HTML converter

• Online converter

PDF to MD

https://pdf2md.morethan.io/

Online interface where we can upload a pdf document and receive back a markdown content. Quite good.

URL to markdown

http://heckyesmarkdown.com/

Bookmarklet that will allow to convert a web page to a markdown document.

XLS to markdown

https://github.com/cavo789/marknotes_xls2md

Excel to markdown converter

• Online converter

Markdown-css

https://github.com/sindresorhus/github-markdown-css

https://github.com/otsaloma/markdown-css

Stylesheets for Markdown to HTML conversion.

Mermaid

https://github.com/mermaid-js/mermaid

Generation of diagram and flowchart from text in a similar manner as markdown http://mermaid-js.github.io/mermaid/.

There is an online editor: https://mermaid-js.github.io/mermaid-live-editor/.

Using the mermaid-cli tool it's possible to convert a markdown file into an image so, using mermaid-cli, it's possible to write a batch script and convert flows into images at once.

Note: if you're using pandoc, there are filters: https://github.com/raghur/mermaid-filter.

Demos:

• Flow
• Sequence
• Gantt chart
• Class
• State
• Pie
• Git

lorem-markdownum

https://github.com/jaspervdj/lorem-markdownum

Lorem Markdownum is a lorem ipsum generator for markdown.

• Online tool

markdown-lint

https://github.com/DavidAnson/markdownlint

A Node.js style checker and lint tool for Markdown/CommonMark files.

This tool will verify the quality of any markdown files and can auto-fix some violations too.

There is an extension for Visual Studio code.

Generate a mindmap from a bullet list

https://markmap.js.org/repl

Write a bullet list in markdown and convert it into a svg file.

Not yet tried: https://www.npmjs.com/package/markmap-cli. That tools seems to convert the markdown file with markmap into a HTML page. It isn't said how the mindmap is rendered (svg, png, ...)?

Convert a folder to an HTML site

https://github.com/joakin/markdown-folder-to-html

This tool will duplicate a folder (the new folder with be prefixed by an underscore) and convert any .md files (whatever the folder's structure) and will convert to .html. The new folder will have an index.html page and a navigation tree so you can browse your content directly from a browser.

Installation

1. Run npm install -g markdown-folder-to-html to install the tool globally
2. Go to a folder where you've markdown files like a wiki project f.i. (let's say c:\christophe\wiki\your-project)
3. In the root folder run markdown-folder-to-html . to convert the entire folder to HTML files. You'll then get a copy into c:\christophe\wiki\_your-project
4. Open a browser and surf to c:\christophe\wiki\_your-project.

Presentation tool (slideshows)

Reveal-md

https://github.com/webpro/reveal-md

reveal.js on steroids! Get beautiful reveal.js presentations from any Markdown file

Remark

https://github.com/gnab/remark

A simple, in-browser, markdown-driven slideshow tool. http://remarkjs.com

Table generator

http://www.tablesgenerator.com/markdown_tables

Highlight: you can copy/paste data from Excel and this site generates the markdown rendering for this table.

Limedocs Wiki converter

https://github.com/limedocs/limedocs-wiki-converter

Generate HTML & PDF documentation from you Github wiki or any other markdown-based wiki.

Other tools, not directly markdown

Diagram tool

https://www.diagram.codes/

Diagram generation tool. The language isn't markdown but a very easy language. Images are generated on-the-fly and can be exported as a SVG file.

License

MIT