yannick-s/mdhtml

convert .md to .html

MDHTML : converting markdown to html files

This library provides a way for converting markdown files to html, to be view in browsers and other. The main aim of this library is for me to learn how to manage a library, write documentation, tests etc, do continuous integration and other things along the way.

This project is inspired by a Podcast I heard here, which creates the same library, however written in python.

After a while I have realized several flaws with Markdowns documentation, and decided to switch to creating a CommonMark parser. The reasons for this are outlined in Commonmark's Homepage. Furthre, there is an extensive testing suite. Thus, once the testing suite is satisfied, I know that this project works.

Usage

$ ./mdhtml -in test.md -out test.html
$ [TODO] ./mdhtml test.md > test.html
$ [TODO] cat test.md | ./mdhtml > test.html

History

• 0.1 Initial Tests
• 0.2 Getting Travis and codecov to work. Adding more badges while I was at it.
• 0.3 Starting on actual project. It also seems that I have misunderstood how tags worked before
• 0.4 At this stage, blocks work. Later I will need to split this package into two, one library and one cli
• 0.5 Some work was done, and I decided to switch to Common Mark.