search

MIT-LCP / mimic-website

Website for the MIMIC Critical Care Database (currently version MIMIC-III)
https://mimic.mit.edu
MIT License
102 stars 111 forks source link

Generate a PDF of the documentation #6

Closed tompollard closed 5 years ago

tompollard commented 9 years ago

A PDF of the documentation should be automatically generated from the web content. One option is to use Pandoc, as we did previously.

kpierceHST commented 9 years ago

another option would be to go the other direction: create the print version of the documentation in latex first, and then used a converter (tth, tex2html, probably pandoc) to generate web pages. That way you can have a nicely typeset print version available, with all the nice cross-referencing and indexing that latex can provide.

On 9/2/15 12:40 AM, Tom Pollard wrote:

A PDF of the documentation should be automatically generated from the web content. One option is to use Pandoc, as we did previously.

Reply to this email directly or view it on GitHub: https://github.com/MIT-LCP/mimic-website/issues/6

tompollard commented 7 years ago

As a starting point, this PDF - mimicguide.pdf - is generated from the the plain text in the content directory using Pandoc:

pandoc -s \
content/frontpage.md \
content/about/mimic.md  \
content/about/acknowledgments.md  \
content/gettingstarted/overview.md \
content/gettingstarted/access.md \
content/gettingstarted/dbsetup.md \
content/gettingstarted/querybuilder.md \
content/mimicdata/*.md \
content/mimictables/*.md  \
content/help.md -o mimicguide.pdf

Some accompanying style files are needed to clean things up, but not a bad start. From a quick glance at the PDF, the main issues seem to be: