Metadata-Version: 2.4
Name: mdformat-lists
Version: 0.0.1
Summary: An mdformat plugin to configure bullet characters for unordered lists and markers for ordered lists
Project-URL: Homepage, https://github.com/brendanmaguire/mdformat-lists
Project-URL: Repository, https://github.com/brendanmaguire/mdformat-lists
Author: Brendan Maguire
License-Expression: MIT
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: mdformat>=1.0.0
Description-Content-Type: text/markdown

# mdformat-lists

A [mdformat](https://github.com/hukkin/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:

```bash
pip install mdformat-lists
```

Then simply run mdformat as usual:

```bash
mdformat <filename>
```

### Configuration

#### Unordered list bullet

Configure the bullet character in `.mdformat.toml`:

```toml
[plugin.lists]
bullet = "*"
```

Or via the command line:

```bash
mdformat --bullet="*" <filename>
```

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

#### Ordered list marker

Configure the ordered list marker in `.mdformat.toml`:

```toml
[plugin.lists]
ordered_marker = ")"
```

Or via the command line:

```bash
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.
