Giter VIP home page Giter VIP logo

Comments (2)

kpierceHST avatar kpierceHST commented on May 24, 2024

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:
#6

from mimic-website.

tompollard avatar tompollard commented on May 24, 2024

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:

  • toml metadata chunks (beginning and ending with "+++") need to be stripped
  • header styles should be more distinct
  • rendering of the tables is messy

from mimic-website.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.