diff options
| author | Benjamin Chausse <benjamin@chausse.xyz> | 2019-09-19 22:00:24 -0400 |
|---|---|---|
| committer | Benjamin Chausse <benjamin@chausse.xyz> | 2019-09-19 22:00:24 -0400 |
| commit | a27998ac4c3ee2cb1dc0f7147a480897ec5d23ec (patch) | |
| tree | dd88b70d678f8eb75f001eb76fb10cecd2a81b5b | |
| parent | 9baaeac2f1eb7e5553e17a83e980985644a198be (diff) | |
README with example formating
| -rw-r--r-- | README.gd | 17 | ||||
| -rw-r--r-- | README.md | 17 | ||||
| -rw-r--r-- | README.pdf | bin | 24003 -> 29333 bytes |
3 files changed, 20 insertions, 14 deletions
@@ -14,16 +14,18 @@ being `pandoc`, it can be quite long to compile a document (up to four seconds for one page documents in some cases) unlike Groff which is known to usually compile very quickly (0.1 second on average for -one page documents). +one page documents). As a proof of concept, this *README* +pages can be fully compiled using groffdown to then be used by groff. +# Example piping workflow Groffdown is a script which when run on a markdown document, will convert the most typical markdown syntax into groff (using the `ms` macros) to then send it to standard output. Therefore, it can be piped directly into groff (or -it's related software). +it's related software). Here is an example of a complete piping +command: -# Example piping workflow -groffdown <filename>.gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T pdf > <filename>.pdf +- groffdown <filename>.gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T pdf > <filename>.pdf # Syntax goals - Speed @@ -35,10 +37,11 @@ groffdown <filename>.gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T p ### Commands similar to markdown - Headers (1-5) -- Italic -- Bold -- Bold & Italic +- *Italic* +- **Bold** +- ***Bold & Italic*** - Bullet points +- `Code blocks (in a monospaced font)` ### Commands similar to LaTeX - Abstract @@ -14,16 +14,18 @@ being `pandoc`, it can be quite long to compile a document (up to four seconds for one page documents in some cases) unlike Groff which is known to usually compile very quickly (0.1 second on average for -one page documents). +one page documents). As a proof of concept, this *README* +pages can be fully compiled using groffdown to then be used by groff. +# Example piping workflow Groffdown is a script which when run on a markdown document, will convert the most typical markdown syntax into groff (using the `ms` macros) to then send it to standard output. Therefore, it can be piped directly into groff (or -it's related software). +it's related software). Here is an example of a complete piping +command: -# Example piping workflow -groffdown <filename>.gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T pdf > <filename>.pdf +- groffdown <filename>.gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T pdf > <filename>.pdf # Syntax goals - Speed @@ -35,10 +37,11 @@ groffdown <filename>.gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T p ### Commands similar to markdown - Headers (1-5) -- Italic -- Bold -- Bold & Italic +- *Italic* +- **Bold** +- ***Bold & Italic*** - Bullet points +- `Code blocks (in a monospaced font)` ### Commands similar to LaTeX - Abstract Binary files differ |