Version Packages (#610)

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
hashicorp · Jun 8, 2022 · cfdac11 · cfdac11 · vercel · Jun 8, 2022
1 parent c4308f5
commit cfdac11
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 46 deletions.
diff --git a/.changeset/four-readers-try.md b/.changeset/four-readers-try.md
diff --git a/packages/docs-page/CHANGELOG.md b/packages/docs-page/CHANGELOG.md
@@ -1,5 +1,49 @@
 # @hashicorp/react-docs-page
 
+## 17.0.0
+
+### Major Changes
+
+- [#607](https://github.com/hashicorp/react-components/pull/607) [`c4308f52`](https://github.com/hashicorp/react-components/commit/c4308f52c77d2f3445a61626f1e430a9b0e6651b) Thanks [@zchsh](https://github.com/zchsh)! - BREAKING CHANGE: no longer provides default remark and rehype plugins.
+
+  Consumers should pass all `remarkPlugins` and `rehypePlugins` through loader options. To match previous behaviour, consumers should import our `@hashicorp/remark-plugins` as well as code highlighting plugins.
+
+  ```ts
+  // Shared remark plugins
+  import {
+    includeMarkdown,
+    paragraphCustomAlerts,
+    typography,
+    anchorLinks,
+  } from '@hashicorp/remark-plugins'
+  // Code highlighting
+  import rehypePrism from '@mapbox/rehype-prism'
+  import rehypeSurfaceCodeNewlines from '@hashicorp/platform-code-highlighting/rehype-surface-code-newlines'
+  // To enable math features, add remarkMath & rehypeKatex
+  // import remarkMath from 'remark-math'
+  // import rehypeKatex from 'rehype-katex'
+
+  const remarkPlugins = [
+    [
+      includeMarkdown,
+      {
+        resolveMdx: true,
+        resolveFrom: path.join(process.cwd(), localPartialsDir),
+      },
+    ],
+    paragraphCustomAlerts,
+    typography,
+    anchorLinks,
+    /* ... option to add more plugins here ... */
+  ]
+
+  const rehypePlugins = [
+    [rehypePrism, { ignoreMissing: true }],
+    rehypeSurfaceCodeNewlines,
+    /* ... option to add more plugins here ... */
+  ]
+  ```
+
 ## 16.2.1
 
 ### Patch Changes

diff --git a/packages/docs-page/package.json b/packages/docs-page/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@hashicorp/react-docs-page",
   "description": "Create a Hashicorp branded docs page in NextJS projects.",
-  "version": "16.2.1",
+  "version": "17.0.0",
   "author": "HashiCorp",
   "contributors": [
     "Jeff Escalante",

diff --git a/packages/glossary-page/CHANGELOG.md b/packages/glossary-page/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @hashicorp/react-glossary-page
 
+## 2.5.9
+
+### Patch Changes
+
+- Updated dependencies [[`c4308f52`](https://github.com/hashicorp/react-components/commit/c4308f52c77d2f3445a61626f1e430a9b0e6651b)]:
+  - @hashicorp/react-docs-page@17.0.0
+
 ## 2.5.8
 
 ### Patch Changes

diff --git a/packages/glossary-page/package.json b/packages/glossary-page/package.json
@@ -1,13 +1,13 @@
 {
   "name": "@hashicorp/react-glossary-page",
   "description": "Create a Hashicorp branded glossary page in NextJS projects.",
-  "version": "2.5.8",
+  "version": "2.5.9",
   "author": "HashiCorp",
   "contributors": [
     "Bryce Kalow"
   ],
   "dependencies": {
-    "@hashicorp/react-docs-page": "^16.0.0",
+    "@hashicorp/react-docs-page": "^17.0.0",
     "@hashicorp/remark-plugins": "^3.3.1"
   },
   "license": "MPL-2.0",