Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kotborealis/patchouli
:sparkles::book: Pandoc wrapper with some filters and configs
https://github.com/kotborealis/patchouli
docker latex pandoc
Last synced: 3 months ago
JSON representation
:sparkles::book: Pandoc wrapper with some filters and configs
- Host: GitHub
- URL: https://github.com/kotborealis/patchouli
- Owner: kotborealis
- License: gpl-3.0
- Created: 2018-02-17T17:27:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T18:31:53.000Z (4 months ago)
- Last Synced: 2024-10-19T06:49:30.780Z (3 months ago)
- Topics: docker, latex, pandoc
- Language: JavaScript
- Homepage:
- Size: 1010 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Patchouli
[](https://microbadger.com/images/kotborealis/patchouli "Get your own image badge on microbadger.com")
Pandoc wrapper with batteries included! 🔋
## Dependencies
* Node 8.0+
* Docker
## Installation
Installation needs root permissions to pull [kotborealis/patchouli](https://hub.docker.com/r/kotborealis/patchouli)
docker image.
```shell script
sudo npm i -g @kotborealis/patchouli --unsafe-perm
```
## Usage
Create `.md` files:
```markdown
00_intro.md
10_general.md
90_conclusion.md
99_references.md
```
Patchouli combines all markdown files into a single file.
Build to pdf (`build.pdf` by default):
```shell script
patchouli
```
Specifying output type:
```shell script
patchouli --type=tex
patchouli --type=pdf
patchouli --type=docx
patchouli --type=revealjs
```
Place `.patchouli.js` in the current directory for advanced configuration
```js
module.exports = {
output: 'desired_output_filename',
type: 'pdf',
}
```
## Literate JS
Supports a form of 'literate'-js. See [example](https://github.com/kotborealis/patchouli/blob/master/test/literate/env/10_intro.md?plain=1).
Use with flag `--literate` or with [such config](https://github.com/kotborealis/patchouli/blob/master/test/literate/env/.patchouli.js).
## Included filters
* [pandoc-crossref](https://lierdakil.github.io/pandoc-crossref/)
--- pandoc filter for numbering figures, equations, tables and cross-references to them.
## Configuration
Patchouli loads configurations and combines from files named `.patchouli.js`
located in home and current directory,
## Latex template
See `%My settings` in `docker/resources/default.latex` file for reference.
### New yaml options
* `figure_H: true` --- adds `[H]` param to figures to keep them in place