mdformat-lists 0.0.3

An mdformat plugin to configure bullet characters for unordered lists and markers for ordered lists

mdformat-lists

A mdformat plugin to configure list markers for unordered and ordered lists.

By default, mdformat uses - as the bullet character (alternating with * for consecutive lists) and . as the ordered list marker. This plugin allows you to choose between -, *, and + for bullets, and . and ) for ordered list markers.

Usage

Install with:

pip install mdformat-lists

Then simply run mdformat as usual:

mdformat <filename>

Configuration

Unordered list bullet

Configure the bullet character in .mdformat.toml:

[plugin.lists]
bullet = "*"

Or via the command line:

mdformat --bullet="*" <filename>

Valid values are - (default), *, and +.

Ordered list marker

Configure the ordered list marker in .mdformat.toml:

[plugin.lists]
ordered_marker = ")"

Or via the command line:

mdformat --ordered-marker=")" <filename>

Valid values are . (default) and ).

When multiple ordered lists appear consecutively, the plugin alternates between the primary and secondary marker (. and )) to prevent Markdown parsers from merging separate lists into one.

Contributing

Pull requests are welcome.

Development

Prerequisites: mise

git clone https://github.com/brendanmaguire/mdformat-lists.git
cd mdformat-lists
mise trust && mise install

Run tasks with mise, for example mise unit-test.