README.md 1.05 KB
Newer Older
Benoit Rat's avatar
Benoit Rat committed
1 2 3 4 5 6 7
---
title:  'Generate WR Starting Kit Documentation'
subtitle: "How to generate starting kit pdf from markdown using pandoc"
author: Seven Solutions
...


8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
Intro
==========


The document has been written in markdown format and can be directly
read from github, gitlab or bitbucket



PDF Generation
===============

You might need to install `pandoc` software to generate `.pdf` from `.md`.

	sudo apt-get install pandoc

To generate a specific document you should enter its own directory and execute

	make

If you have some Latex compilation error please install the following packages

	sudo apt-get install texlive texlive-latex-extra

### pandoc.latex

The file pandoc.latex is a latex template in order to add all special latex customization
to the markdown file. In case some of latex package are not working properly, the user
should try to modify this file.


Syntax
===========

> ***NOTES:*** The syntax used in this document is Markdown. We recommand to follow the strict
markdown syntax explained on [bitbucket](https://bitbucket.org/tutorials/markdowndemo).