From a27998ac4c3ee2cb1dc0f7147a480897ec5d23ec Mon Sep 17 00:00:00 2001 From: Benjamin Chausse Date: Thu, 19 Sep 2019 22:00:24 -0400 Subject: README with example formating --- README.gd | 17 ++++++++++------- README.md | 17 ++++++++++------- README.pdf | Bin 24003 -> 29333 bytes 3 files changed, 20 insertions(+), 14 deletions(-) diff --git a/README.gd b/README.gd index 1cf90e9..df3d0d0 100644 --- a/README.gd +++ b/README.gd @@ -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 .gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T pdf > .pdf +- groffdown .gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T pdf > .pdf # Syntax goals - Speed @@ -35,10 +37,11 @@ groffdown .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 diff --git a/README.md b/README.md index 1cf90e9..df3d0d0 100644 --- a/README.md +++ b/README.md @@ -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 .gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T pdf > .pdf +- groffdown .gd | refer -PS -e "-p$REFERBIB" | groff -me -ms -kejpt -T pdf > .pdf # Syntax goals - Speed @@ -35,10 +37,11 @@ groffdown .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 diff --git a/README.pdf b/README.pdf index 29c9771..cf39aba 100644 Binary files a/README.pdf and b/README.pdf differ -- cgit v1.2.3