dahak-metagenomics / dahak

benchmarking and containerization of tools for analysis of complex non-clinical metagenomes.
https://dahak-metagenomics.github.io/dahak
BSD 3-Clause "New" or "Revised" License
21 stars 4 forks source link

Docs to pdf #128

Closed charlesreid1 closed 6 years ago

charlesreid1 commented 6 years ago

Add script+instructions for creating a final PDF from the documentation using mkdocs-pandoc.

Also adds documentation to the binary file dahak_docs.pdf

Merge Checklist

charlesreid1 commented 6 years ago

Link to the nice PDF version of the documentation: https://github.com/dahak-metagenomics/dahak/raw/df948251056dd61cebf66d9dbe9c1277c30b60a0/dahak_docs.pdf

brooksph commented 6 years ago

Nice! It seems as though pandocs does not automatically wrap the text as some of the code blocks are outside of the margins (e.g. pg 5, 19, etc.). An alternative to manually inserting line breaks is not readily apparent. Any thoughts @charlesreid1?

charlesreid1 commented 6 years ago

Hmm... most are URLs so we can turn those into TinyURLs. The rest are walkthru/docker commands that can be broken up and line-wrapped with \