Skip to content

Commit

Permalink
doc: prepare v1.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleKing committed Jan 12, 2023
1 parent d0add1f commit aab4b4d
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,11 @@

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 of any code that isn't properly formatted!
## 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)

Tip: this package has a pip extra, `recommended`, of plugins that work well with mkdocs:
Tip: this package specifies an "extra" (`recommended`) for plugins that work well with mkdocs:

- [mdformat-admon](https://pypi.org/project/mdformat-admon)
- [mdformat-beautysh](https://pypi.org/project/mdformat-beautysh)
Expand Down
2 changes: 1 addition & 1 deletion mdformat_mkdocs/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""An mdformat plugin for mkdocs."""

__version__ = "0.0.1"
__version__ = "1.0.0"

from .plugin import POSTPROCESSORS, RENDERERS, update_mdit # noqa: F401

0 comments on commit aab4b4d

Please sign in to comment.