doc: Updated readme

typedoc2md · Apr 18, 2023 · f590719 · f590719
1 parent eb943a6
commit f590719
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/packages/typedoc-plugin-markdown/README.md b/packages/typedoc-plugin-markdown/README.md
@@ -13,18 +13,20 @@ The plugin replaces the default HTML theme with a built-in Markdown theme and ex
 
 ## Installation
 
+> Please note the `next` pre-release version may contain breaking changes within the same semantic version.
+
 ```bash
 npm install typedoc-plugin-markdown@next --save-dev
 ```
 
-> Please note the `next` version may contain breaking changes within the same semantic version without warning.
-
 ## Usage
 
 ```bash
 typedoc --plugin typedoc-plugin-markdown
 ```
 
+Generated Markdown is now parsed with [Prettier](https://prettier.io/) which is backed by the remark-parse package. This does require an additional peer dependency, however introduces a consistent output format.
+
 ## Options
 
 The following options can be used in addition to relevant [TypeDoc options](https://typedoc.org/options/)