Metadata-Version: 2.1
Name: mdformat_mkdocs
Version: 0.0.1
Summary: An mdformat plugin for mkdocs.
Keywords: mdformat,markdown,markdown-it
Author-email: Kyle King <dev.act.kyle@gmail.com>
Requires-Python: >=3.7.2
Description-Content-Type: text/markdown
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: mdformat >=0.7.0,<0.8.0
Requires-Dist: mdit-py-plugins >=0.3.2
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: mdformat-admon ; extra == "recommended"
Requires-Dist: mdformat-beautysh ; extra == "recommended"
Requires-Dist: mdformat-black ; extra == "recommended"
Requires-Dist: mdformat-config ; extra == "recommended"
Requires-Dist: mdformat-frontmatter ; extra == "recommended"
Requires-Dist: mdformat-gfm ; extra == "recommended"
Requires-Dist: mdformat-tables ; extra == "recommended"
Requires-Dist: mdformat-toc ; extra == "recommended"
Requires-Dist: mdformat-web ; extra == "recommended"
Requires-Dist: pytest>=6.0 ; extra == "test"
Requires-Dist: pytest-cov ; extra == "test"
Project-URL: Homepage, https://github.com/KyleKing/mdformat-mkdocs
Provides-Extra: dev
Provides-Extra: recommended
Provides-Extra: test

# mdformat-mkdocs

[![Build Status][ci-badge]][ci-link] [![PyPI version][pypi-badge]][pypi-link]

<!-- [![codecov.io][cov-badge]][cov-link]
[cov-badge]: https://codecov.io/gh/executablebooks/mdformat-mkdocs/branch/main/graph/badge.svg
[cov-link]: https://codecov.io/gh/executablebooks/mdformat-mkdocs
 -->

An [mdformat](https://github.com/executablebooks/mdformat) plugin for mkdocs.

> *Warning*
>
> This is an initial proof of concept. Non-list items nested within a list are not properly handled (i.e. nested code blocks, quotes, etc.). Please [open an issue](https://github.com/KyleKing/mdformat-mkdocs/issues/new) and share examples that aren't properly supported!

## Usage

Add this package wherever you use `mdformat` and the plugin will be auto-recognized. No additional configuration necessary. See [additional information on `mdformat` plugins here](https://mdformat.readthedocs.io/en/stable/users/plugins.html)

### Pre-commit

```yaml
repos:
  - repo: https://github.com/executablebooks/mdformat
    rev: 0.7.16
    hooks:
      - id: mdformat
        additional_dependencies:
          - mdformat-mkdocs
```

### pipx

```sh
pipx install mdformat
pipx inject mdformat mdformat-mkdocs
```

## Caveats

- All indents are converted to 4-spaces
- This plugin converts all bulleted items to dashes and numerals to `1.`

See the example test files, [./tests/pre-commit-test.md](https://raw.githubusercontent.com/KyleKing/mdformat-mkdocs/main/tests/pre-commit-test.md) and [./tests/fixtures.md](https://raw.githubusercontent.com/KyleKing/mdformat-mkdocs/main/tests/fixtures.md)

## Contributing

See [CONTRIBUTING.md](https://github.com/KyleKing/mdformat-mkdocs/blob/main/CONTRIBUTING.md)

[ci-badge]: https://github.com/executablebooks/mdformat-mkdocs/workflows/CI/badge.svg?branch=main
[ci-link]: https://github.com/executablebooks/mdformat/actions?query=workflow%3ACI+branch%3Amain+event%3Apush
[pypi-badge]: https://img.shields.io/pypi/v/mdformat-mkdocs.svg
[pypi-link]: https://pypi.org/project/mdformat-mkdocs

