From aab4b4da1ed736431b3a970292717e19758027a0 Mon Sep 17 00:00:00 2001 From: Kyle King Date: Wed, 11 Jan 2023 20:04:12 -0500 Subject: [PATCH] doc: prepare v1.0.0 release --- README.md | 6 +----- mdformat_mkdocs/__init__.py | 2 +- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 58964e7..adc4a65 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/mdformat_mkdocs/__init__.py b/mdformat_mkdocs/__init__.py index adc377c..f85cc41 100644 --- a/mdformat_mkdocs/__init__.py +++ b/mdformat_mkdocs/__init__.py @@ -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