GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → sergiocorreia → Panflute

sergiocorreia / Panflute

Licence: bsd-3-clause
An Pythonic alternative to John MacFarlane's pandocfilters, with extra helper functions

Programming Languages

python
139335 projects - #7 most used programming language

Labels

markdownfilterpandoc

Projects that are alternatives of or similar to Panflute

Pandoc Plantuml Filter
Pandoc filter for PlantUML code blocks
Stars: ✭ 51 (-82.17%)
Mutual labels:  markdown, pandoc, filter
Pandoc Markdown Template
Markdown templates for Pandoc
Stars: ✭ 135 (-52.8%)
Mutual labels:  markdown, pandoc
Pandoc Action Example
using the pandoc document converter on GitHub Actions
Stars: ✭ 131 (-54.2%)
Mutual labels:  markdown, pandoc
Pandoc Markdown Book Template
A template for creating epub books from markdown using pandoc.
Stars: ✭ 191 (-33.22%)
Mutual labels:  markdown, pandoc
Oscp Exam Report Template Markdown
📙 Markdown Templates for Offensive Security OSCP, OSWE, OSCE, OSEE, OSWP exam report
Stars: ✭ 2,066 (+622.38%)
Mutual labels:  markdown, pandoc
Pandiff
Prose diffs for any document format supported by Pandoc
Stars: ✭ 110 (-61.54%)
Mutual labels:  markdown, pandoc
Rmarkdown
Dynamic Documents for R
Stars: ✭ 2,319 (+710.84%)
Mutual labels:  markdown, pandoc
Pandoc Sidenote
Convert Pandoc Markdown-style footnotes into sidenotes
Stars: ✭ 78 (-72.73%)
Mutual labels:  markdown, pandoc
Tufte Pandoc Css
Starter files for using Pandoc Markdown with Tufte CSS
Stars: ✭ 215 (-24.83%)
Mutual labels:  markdown, pandoc
pandoc-latex-environment
Pandoc filter for adding LaTeX environement on specific div
Stars: ✭ 27 (-90.56%)
Mutual labels:  filter, pandoc
pandocker
🐳 A simple docker image for pandoc with filters, templates, fonts, and the latex bazaar
Stars: ✭ 118 (-58.74%)
Mutual labels:  filter, pandoc
Markdown Cv
Simple Markdown CV / Resume
Stars: ✭ 97 (-66.08%)
Mutual labels:  markdown, pandoc
Science.md
An easy framework for drafting scientific documents: Write (Markdown), Compile (PDF, Word, HTML), Share.
Stars: ✭ 90 (-68.53%)
Mutual labels:  markdown, pandoc
Patat
Terminal-based presentations using Pandoc
Stars: ✭ 1,725 (+503.15%)
Mutual labels:  markdown, pandoc
Linl
Linl Is Not Letter -- Markdown-based LaTeX Letter Template
Stars: ✭ 84 (-70.63%)
Mutual labels:  markdown, pandoc
Awesome Scientific Writing
⌨️ A curated list of awesome tools, demos and resources to go beyond LaTeX
Stars: ✭ 162 (-43.36%)
Mutual labels:  markdown, pandoc
Hypermark
Markdown for Humans.
Stars: ✭ 266 (-6.99%)
Mutual labels:  markdown, filter
Markdeck
presentations as code - author cool slide decks, text-only, offline-ready, collaborative
Stars: ✭ 1,159 (+305.24%)
Mutual labels:  markdown, pandoc
Ieee Pandoc Template
IEEE paper template for pandoc
Stars: ✭ 76 (-73.43%)
Mutual labels:  markdown, pandoc
Pandoc Book Template
A simple Pandoc template to build documents and ebooks.
Stars: ✭ 214 (-25.17%)
Mutual labels:  markdown, pandoc
View All Similar Projects ➔

Panflute: Pythonic Pandoc Filters

Python version PyPI version Development Status Build Status

panflute is a Python package that makes creating Pandoc filters fun.

For a detailed user guide, documentation, and installation instructions, see http://scorreia.com/software/panflute/. For examples that you can use as starting points, check the examples repo, the sample template, or this github search. If you want to contribute, head here.

You might also find useful this presentation on how I use markdown+pandoc+panflute to write research papers (at the Banco de Portugal 2019 Workshop on Reproductible Research).

Install

To install panflute, open the command line and type:

pip install panflute

Upgrade

To upgrade panflute, open the command line and type:

pip install panflute -U

Uninstall

To uninstall panflute, open the command line and type:

pip uninstall panflute

Dev Install

After cloning the repo and opening the panflute folder:

python setup.py install: installs the package locally

python setup.py develop: installs locally with a symlink so changes are automatically updated

Note on versions

panflute 1.12 or above dropped support of Python 2. When using Python 3, depending on your setup, you may need to use pip3/python3 explicitly. If you need to use panflute in Python 2, install panflute 1.11.x or below.

Currently supported Python versions: Python version. Check setup.py for details, which further indicates support of pypy on top of CPython.

Supported pandoc versions

pandoc versioning semantics is MAJOR.MAJOR.MINOR.PATCH and panflute's is MAJOR.MINOR.PATCH. Below we shows matching versions of pandoc that panflute supports, in descending order. Only major version is shown as long as the minor versions doesn't matter.

panflute version supported pandoc versions supported pandoc API versions
2.0 2.11.0.4—2.11.x 1.22
not supported 2.10 1.21
1.12 2.7-2.9 1.17.5–1.20

Note: pandoc 2.10 is short lived and 2.11 has minor API changes comparing to that, mainly for fixing its shortcomings. Please avoid using pandoc 2.10.

Contributing

Feel free to submit push requests. For consistency, code should comply with pep8 (as long as its reasonable), and with the style guides by @kennethreitz and google. Read more here.

License

BSD3 license (following pandocfilters by @jgm).

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].