Skip to content

garlicbreadcleric/pandoc-toolbox

Repository files navigation

Pandoc Toolbox

A collection of tools for using Pandoc for Markdown preview (see Document Preview VS Code extension) and more.

Output example:

Features:

  • pandoc-iconify — a Pandoc filter that adds different FontAwesome icons to different kinds of links (Wikipedia, GitHub, Generic Web and Internal links).
  • preview.html — a Pandoc template that bundles HTML output with scripts and styles in a single HTML file for easier preview. There's also preview-body.html template for incrementally updating just the body (to avoid loading the whole bundle on each previewer update). The template includes FontAwesome, Mermaid and KaTeX (CSS/fonts only, Pandoc filter is still required).

Coming soon:

  • pandoc-lightbox — a Pandoc filter that allows to open images in a modal.
  • Templates without bundling (not for preview).

Usage

npm i -g pandoc-katex

git clone https://github.com/garlicbreadcleric/pandoc-toolbox
cd pandoc-toolbox
npm i
npm link

pandoc -f markdown path/to/input.md -o path/to/output.html --template=./templates/preview.html -F pandoc-iconify -F pandoc-katex

If you want to use pandoc-iconify without these templates, you'll need to add CSS from assets/iconify.css.

See also

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages