nero
/
grapho
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
17 Commits 1 Branch 0 Tags 49 KiB
Shell 66.5%
Awk 33.5%
Go to file
Nero 2ac267e68f Fix incorrect regex: asterisks don't need to be quoted when used in a character set. This incorrectly included the backslash into the character set. 2024-03-27 08:53:16 +00:00
README.md Improve multi-language support 2022-07-02 20:55:45 +00:00
md2html md2html: Remove html entities for summary, input data is already escaped 2024-03-27 08:52:16 +00:00
md2tex Fix incorrect regex: asterisks don't need to be quoted when used in a character set. This incorrectly included the backslash into the character set. 2024-03-27 08:53:16 +00:00

README.md

grapho - documentation compiler

I write documentation in markdown. Many people don't like to read markdown. md2html converts markdown into an HTML page which i can publish directly. md2tex converts marktown into a TEX document, which i compile into a professional-academia-looking PDF using pdflatex.

Usage

The input markdown goes into stdin. The output document comes out of stdout.

Examples:

md2html < README.md > README.html
firefox README.html

md2tex < README.md > README.tex
pdflatex README.tex

If the awk option stylesheet is given, the HTML document can made prettier with external CSS.

md2html -v stylesheet='/style.css' < README.md

Supported constructs

  • Headlines up to level 6
  • Paragraphs
  • Bold, italic and inline monospace
  • Image figures if they are in the same folder
  • Code listings
  • URL references
  • Lists

Not supported

  • Tables
  • Images from an url
  • Images inline in text
  • Unicode characters (im german, maybe i will add at least umlaut support)