Improve document generation process #17

Closed
jfhbrook opened this Issue Nov 17, 2011 · 5 comments

Projects

None yet

2 participants

@jfhbrook

Right now, the handbook is a collection of markdown files that are stacked together and parsed by ronn and make. I think we can do better.

Ideally, this is what we would want:

  1. An html representation.
  2. A .pdf or other "book" format.

It may make sense to build a docs-style site for our handbook, and then build an "equivalent" generator for .pdf documents.

@blakmatrix

Can we close this ore does there still need to be a reason for this to be open because we have pdf and html working

@jfhbrook

I think we're close. I agree that the current tools (ronn, make, etc) are sufficient for this task, but there are a few tweaks left I want to implement.

@blakmatrix

I'd actually like to postulate that we move awayfrom the ruby tool ronn and perhaps elect to use nodejs tools for both to make this much simpler on any system we may have

@jfhbrook

I'd be open to that, though we'd have to find these tools first.

If you have tools in mind for replacing ronn and htmldoc (I have a branch using pandoc but the gains were pretty negligible), feel free to bring them up.

@blakmatrix

we are now using blacksmith to generate the handbook website

@blakmatrix blakmatrix closed this Dec 5, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment