kotborealis/patchouli repository overview

⁠Patchouli

Pandoc wrapper

⁠Installation

# Build docker image (VERY slow, ~3.66gb)
npm run-script build
# Install wrapper
npm i -g .

⁠Usage

# Compile file to html:
patchouli file.md

# Compile file to pdf:
patchouli file.md --type pdf

# Compile file to docx
patchouli file.md --type=docx

# Live reload:
patchouli live file.md

# Clean all generated pdf/html files:
patchouli clean

Concat files

 writing/s6/na_lab4 ls
00_header.md  01_tasks.md  02_theory.md  03_task1.md  04_task2.md  05_task3.md  99_appendix.md

Command patchouli --concat=build.md will concatenate all .md files into build.md and compile it to build.pdf, removing build.md afterwards. Pass --keep-concat if you want to keep this file.

⁠Included filters

• pandoc-svg⁠
• pandoc-crossref⁠
• pandoc-include-code⁠

⁠Configuration

This wrapper loads the following configs in the same order and combines them using deep-merge:

• .../patchouli/.patchouli.js
• ~/.patchouli.js
• $PWD/.patchouli.js

⁠Arguments

• live --- run live-server and watch files
• watch --- watch files
• clean --- remove output files
• --type=html --- specify output type (html, pdf, tex, docx)
• --concat=build.md --- concat files into specified file and then compile it
• --keep-concat --- keep concatenated file
• --keep-tex --- keep tex file
• --pandoc-*=? --- pass --*=? argument to pandoc

⁠Init

patchouli init let's you init project with some of the files from resources. This needs to be reworked a bit.

⁠Default template

⁠yaml options

• figure_H: true --- adds [H] param to figures to keep them in place