This repository represents a number of Pandoc Filters that can be used to generate documentation. These filters allow for files written in Markdown, too be converted into \LaTeX using Pandoc, which can then be used to produce a PDF.

The columns filter adds the ability to have multi-column sections. It requires the multicols package. Use:

:::col-n CONTENT ::: 

Where n is the number of columns you wish. For example:

:::col-3 this will be in three columns ::: 

Normal markdown will work as the contents.

The indent filter does as it says on the tin. It indents the contents. It can be nested if you want. It requires the changepage package.

This is a normal paragraph :::indent This is indented once :::indent This is indented twice ::: ::: 

This filter is used for highlighting sections of code. Note that this IS NOT syntax highlighting, but for drawing attention to sections of code.

It requires the soul package for highlighting.

It requires pandoc to be called with the listings option.

It also requires listings to be set with escapeinside specified in lstset. The below should be in the latex template used by pandoc.

\lstset{	escapeinside={\#(}{\#)},	breaklines=true, } 

It expects a number of latex colours to be set using the xcolor package:

\definecolor{RCcritical}{HTML}{F50D25} \definecolor{RChigh}{HTML}{AC0619} \definecolor{RCmedium}{HTML}{FDBF2D} \definecolor{RClow}{HTML}{94CE58} \definecolor{RCinfo}{HTML}{2BA2E6} 

And it expects the following latex macros to be defined:

\definecolor{RCblue}{HTML}{09347a} \newcommand{\codeSnip}{\textit{\textbf{\textcolor{RCblue}{--SNIP--}}}} \newcommand{\codeRedacted}{\textit{\textbf{\textcolor{RCblue}{--REDACTED--}}}} 

``` def login(username, password): hard_coded_username = "user123" {MEDIUM}hard_coded_password = "{REDACTED}"{/MEDIUM} {CODECOMMENT: Hard Coded Credentials} Something about why *hard coded* credentails are bad {/CODECOMMENT} if username == hard_coded_username and password == hard_coded_password: return True else: return False ``` 

This shows how code can be highlighted. In this example, {MEDIUM} is used. It is possible to use any of the following:

• CRITICAL
• HIGH
• MEDIUM
• LOW
• INFORMATIONAL
• YELLOW
• RED
• ORANGE
• BLUE
• GREEN

The {REDACTED} or {SNIP} shortcodes insert the \codeSnip or \codeRedacted latex macro.

The multi-line {CODECOMMENT} shortcode adds a centred "notes" box to the code block which can be useful for annotating code.