From 3a5640d662c25ce2d3dbf0a77086c63594d350b9 Mon Sep 17 00:00:00 2001 From: tgreyuk Date: Sat, 22 Jun 2024 21:08:16 +0100 Subject: [PATCH] chore(docs): updated docs --- docs/pages/docs/versioning.mdx | 26 +++++++-------------- packages/typedoc-plugin-remark/CHANGELOG.md | 2 +- 2 files changed, 9 insertions(+), 19 deletions(-) diff --git a/docs/pages/docs/versioning.mdx b/docs/pages/docs/versioning.mdx index 05f3dcf3..28a214b4 100644 --- a/docs/pages/docs/versioning.mdx +++ b/docs/pages/docs/versioning.mdx @@ -2,7 +2,7 @@ This page should help you understand the versioning rules of the plugin and its compatibility with TypeDoc. -## Versioning Rules +## Package Version Please note that TypeDoc is still released within the 0.x.x range and may include breaking changes within each minor version release. @@ -13,23 +13,13 @@ For this reason we follow a slightly amended version of semver: Any option changes will attempt to be made in a backwards compatible manor. - **Major** versions will be made if significant and breaking changes to the plugin are made. -## Compatibility Table - -| typedoc-plugin-markdown | TypeDoc | Release Date | -| ----------------------- | ------- | ------------ | -| 4.1.x | 0.26.x | 2024-06-22 | -| 4.0.x | 0.25.x | 2024-05-03 | +## Node Version -## Specifying Version Ranges +We will follow the Node.js version specified in the TypeDoc `package.json` file. -You may prefer to fix versions or use a tilde (~) when declaring `typedoc-plugin-markdown` and `TypeDoc` versions in your `package.json` file. -The tilde allows only patch updates within the specified minor version. +## Compatibility Table -```json filename="package.json" -{ - "devDependencies": { - "typedoc": "~0.26.0", - "typedoc-plugin-markdown": "~4.1.0" - } -} -``` +| typedoc-plugin-markdown | TypeDoc | Node Version | Release Date | +| ----------------------- | ------- | ------------ | ------------ | +| 4.1.x | 0.26.x | >= 18 | 2024-06-22 | +| 4.0.x | 0.25.x | >= 16 | 2024-05-03 | diff --git a/packages/typedoc-plugin-remark/CHANGELOG.md b/packages/typedoc-plugin-remark/CHANGELOG.md index 1a5ee511..a82d4031 100644 --- a/packages/typedoc-plugin-remark/CHANGELOG.md +++ b/packages/typedoc-plugin-remark/CHANGELOG.md @@ -1,6 +1,6 @@ # Changelog -## 1.0.2 +## 1.0.2 (2024-06-22) ### Patch Changes