symphony-org / frost

Frost
BSD 3-Clause "New" or "Revised" License
19 stars 5 forks source link

Generate single html #63

Closed EncodePanda closed 4 years ago

EncodePanda commented 4 years ago

After this change we get:

  1. better UX by providing arguments with flags
  2. single html generated from multiple sources
  3. templating mechanism (user can provide its own styles)
  4. table of contents automatically generated (if $toc$ present somewhere in the template)

Example usage:

Usage: frost [--input STRING]... [--template STRING] --output STRING

Available options: -h,--help Show this help text --input STRING... Files from which documentation is generated. Accepts multiple values --template STRING (optional) HTML template used to generate the documentation --output STRING Path to a file that will hold generated documentation


* creating documenation with template (that has table of content in it)

$> frost --input ./examples/git.md \ --input ./examples/python.md \ --output doc.html --template ./examples/standalone.html



gives us

![image](https://user-images.githubusercontent.com/6287558/75578248-c74a0300-5a63-11ea-9eb7-82e24630633e.png)
lukasz-golebiewski commented 4 years ago

Cool stuff! Travis is unhappy though

EncodePanda commented 4 years ago

@lukasz-golebiewski Travis is now happy :)

EncodePanda commented 4 years ago

Template from https://github.com/diversen/pandoc-uikit