2021-12-12 13:25:22 +01:00
|
|
|
# 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.
|
|
|
|
|
|
|
|
|
|
```
|
2022-07-02 22:55:45 +02:00
|
|
|
md2html -v stylesheet='/style.css' < README.md
|
2021-12-12 13:25:22 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Supported constructs
|
|
|
|
|
|
2022-07-02 22:55:45 +02:00
|
|
|
- Headlines up to level 6
|
2021-12-12 13:25:22 +01:00
|
|
|
- Paragraphs
|
|
|
|
|
- Bold, italic and inline monospace
|
|
|
|
|
- Image figures if they are in the same folder
|
|
|
|
|
- Code listings
|
2021-12-12 13:28:53 +01:00
|
|
|
- URL references
|
2021-12-12 13:25:22 +01:00
|
|
|
- Lists
|
|
|
|
|
|
|
|
|
|
## Not supported
|
|
|
|
|
|
|
|
|
|
- Tables
|
|
|
|
|
- Images from an url
|
2022-07-02 22:55:45 +02:00
|
|
|
- Images inline in text
|
|
|
|
|
- Unicode characters (im german, maybe i will add at least umlaut support)
|
