Eisvogel automation

This little script aims at automating the use of the Eisvogel template by Pascal Wagler. Feel free to use it, modify it, and do whatever you want with it.

I tried my best to remember all the dependencies, I had to install to make it work, but I might have forgotten some. If you encounter any issue, please let me know.

Installation

Install Pandoc USING CABAL preferred method if you want to try to make the bibliography work, and LaTeX.

Install the Eisvogel template.

Execute the following :

sudo apt update
sudo apt install texlive-xetex texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra texlive-science

Usage

The following options are supported :

$ ./script.sh 
Usage: ./script.sh [options] <markdown-file>
Options:
    --author/-a author            Specify the author
    --date/-d date                Specify the date
    --keywords/-k keywords        Specify the keywords
    --margin/-m margin            Specify the margin
    --footer/-f footer            Specify the footer
    --toc/-t                      Include table of contents
    --output-file/-o output-file  Specify the output file
    --help/-h                     Display this help message

If you wish to change default values, go to the configuration file.

Footnotes

If you want to use footnotes in your markdown, you can use the following syntax :

This is a footnote[^1].

[^1]: This is the text of the footnote.

You can use the following Pandoc options to customize the look and the backlinking of the footnotes :

footnotes_pretty="true"
footnotes_disable_backlinks="false"

Bibliography

I can't manage to make the bibliography (the integration of a .bib file) work with the script. If you have any idea, please let me know.

In the meantime, you will have to either use the footnotes references, or hard-coded references using Latex ^{[1]} format, that looks something like this.

Anyway, if you are doing a project so big you have to including a bibliography, you should probably use LaTeX directly, Pandoc can only do so much.

Explanation

The script isn't really clean, it is mostly useful, here are a few things you should know :

• Your markdown file is copied as temp.md and then modified, so no changes are made to your original file. BUT, if you already have a temp.md file, it will ask you if you want to overwrite it.
• The script takes your first first-level title as the title of the document, then remove it from the markdown.
• Because a markdown file is only supposed to have one first-level title, and that it is removed from the markdown, the script then removes a # from all the titles in the markdown, to bring them one level higher. If you have multiple first-level titles, don't worry, the script won't delete the # from them and transform them into plain text, it will just bring the second-level titles to first-level beside them.

Common errors

• If you encouter a file not found type of error, it is usually because you pass a relative path to the script, for example using ~ instead of /home/your-username.

License

This project is licensed under the MIT License - see the LICENSE file for details.