% Pandoc Documentation writer % komola UG, Sebastian Hoitz
Pandoc-documentation can be used as a documentation toolchain. You can write nice
and readable markdown and it will turn your file into a nice PDF.
Features included:
- Use Markdown to write your documentation
- Create sequence diagrams using plantUML
- Create PDFs
To get the pandoc documentation package to work, you have to install some pre-requisites:
- First of all, get Pandoc. There are builds available for Windows, Mac and Linux.
- Install PlantUML:
- Make sure, you have GraphVIZ installed (a requirement by plantuml)
- Install a Tex package (on OSX, MacTex is a good solution)
- Make sure you have Coffee Script installed. Right now this is used for parsing the plantuml when converting to PDFs.
Once you are done installing all the packages, you can start using the Pandoc Documentation writer like this:
./build README.md README.pdf
- Don't use CoffeeScript but Haskell to parse the plantuml
- Make sure plantuml graphics are scaled correct
When you want to participate in pandoc-documentation, feel free to fork this repository.
Make sure, that you add your changes on a named branch. No pull request will be accepted for master branch changes.
Check the TODO items in this readme for ideas on what to implement.
The following examples are supposed to show you, what you can achieve with pandoc-documentation.
You can easily include sequence diagrams using PlantUML:
This is the description shown in the listings view
@startuml
skinparam monochrome true
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
First column Second column Third column
Asd Foo Bar Asd lalala Bar Asd Foo Bar