pandoc-glfm 0.1.1.0

A pandoc filter for Gitlab Flavored Markdown

Installation

pandoc-glfm is a pandoc filter for adding some GitLab Flavored Markdown features to pandoc:

• tip (note, tip, important, caution, warning) with title

  > [!tip] My title
  > My tip
  

• task lists (with disabled tasks)

  * [x] Finished task
  * [ ] To do task
  * [~] Disabled task
  

Instructions

pandoc-glfm requires python, a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed on Windows.

Install pandoc-glfm using the bash command

$ pipx install pandoc-glfm

To upgrade to the most recent release, use

$ pipx upgrade pandoc-glfm

pipx is a script to install and run python applications in isolated environments from the Python Package Index, PyPI. It can be installed using instructions given here.

Getting Help

If you have any difficulties with pandoc-glfm, please feel welcome to file an issue on github so that we can help.

Contribute

Instructions

Install hatch, then run

$ hatch run pip install pre-commit
$ hatch run pre-commit install

to install pre-commit before working on your changes.

Tests

When your changes are ready, run

$ hatch test
$ hatch fmt --check
$ hatch run lint:check
$ hatch run docs:build
$ hatch build -t wheel

for running the tests, checking the style, building the documentation and building the wheel.