At this time, this template is designed for mainly Linux distributions. Thus, it uses many commands that are basically available on most Linux distributions (e.g.
make,sed,tput...). Basically, with some few efforts this template can be used on another operating system (e.g. Windows and MacOS)... this is planed in future prospects (when I’ve got time!).
Mandatory pre-requires
Prior to use the pandoc-df-thesis-template the following applications must be available on your system:
-
Pandoc for converting the Markdown to the output format of your choice.
- Simply follow the installation instructions from Pandoc documentation: Installing Pandoc
- Also recommended Pandoc filters:
- Pandoc-citeproc: for citations
- Pandoc-crossref: for references.
-
PP – A generic Pre-processor (with Pandoc in mind).
- PP allows to pre-process the Markdown sources, enabling macros (or commands) in the “modified” markdown sources.
- Installation: (see also PP documentation)
- Download and extract pp.tgz.
- Run
make(ormake install) in thepp/folder.
- A
makebuild system: all the template build workflow relies on the use of aMakefile. Thus, you should have a suitablemakesoftware. - A LaTeX distribution (e.g. TeXLive, MiKTeX, MacTeX…)
- Also recommended: LuaLateX, BibLatex (with
biber), glossaries packages
If you don’t plan to build to PDF output, the LaTeX distribution is not mandatory... but I’m not sure that you can fully use Pandoc in such case
- Also recommended: LuaLateX, BibLatex (with
Useful (recommanded) pre-requires
- ImageMagick : for image conversion between the different target.
- NPM : for complementary packages (eg. Bootstrap, JQuery, MathJax, svgo...) mainly to deal with the HTML target.
- SASS (Syntactically Awesome Style Sheets): a style-sheet language to manage CSS for HTML target.