feat: add plugin-markdown-include (#280)

vuepress · Oct 24, 2024 · c9534f2 · c9534f2
1 parent 62b4599
commit c9534f2
Show file tree

Hide file tree

Showing 16 changed files with 902 additions and 0 deletions.
diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
@@ -9,6 +9,7 @@ import { docsearchPlugin } from '@vuepress/plugin-docsearch'
 import { feedPlugin } from '@vuepress/plugin-feed'
 import { markdownExtPlugin } from '@vuepress/plugin-markdown-ext'
 import { markdownImagePlugin } from '@vuepress/plugin-markdown-image'
+import { markdownIncludePlugin } from '@vuepress/plugin-markdown-include'
 import { markdownMathPlugin } from '@vuepress/plugin-markdown-math'
 import { markdownStylizePlugin } from '@vuepress/plugin-markdown-stylize'
 import { redirectPlugin } from '@vuepress/plugin-redirect'
@@ -98,6 +99,9 @@ export default defineUserConfig({
       mark: true,
       size: true,
     }),
+    markdownIncludePlugin({
+      deep: true,
+    }),
     markdownMathPlugin({
       type: 'katex',
     }),
@@ -167,4 +171,6 @@ export default defineUserConfig({
       : [],
     cachePlugin(),
   ],
+
+  pagePatterns: ['**/*.md', '!**/*.snippet.md', '!.vuepress', '!node_modules'],
 })
diff --git a/docs/.vuepress/configs/sidebar/en.ts b/docs/.vuepress/configs/sidebar/en.ts
@@ -101,6 +101,7 @@ export const sidebarEn: SidebarOptions = {
     'markdown-container',
     'markdown-ext',
     'markdown-image',
+    'markdown-include',
     'markdown-hint',
     'markdown-math',
     'markdown-stylize',

diff --git a/docs/.vuepress/configs/sidebar/zh.ts b/docs/.vuepress/configs/sidebar/zh.ts
@@ -101,6 +101,7 @@ export const sidebarZh: SidebarOptions = {
     'markdown-container',
     'markdown-ext',
     'markdown-image',
+    'markdown-include',
     'markdown-hint',
     'markdown-math',
     'markdown-stylize',

diff --git a/docs/package.json b/docs/package.json
@@ -20,6 +20,7 @@
     "@vuepress/plugin-feed": "workspace:*",
     "@vuepress/plugin-markdown-ext": "workspace:*",
     "@vuepress/plugin-markdown-image": "workspace:*",
+    "@vuepress/plugin-markdown-include": "workspace:*",
     "@vuepress/plugin-markdown-math": "workspace:*",
     "@vuepress/plugin-markdown-stylize": "workspace:*",
     "@vuepress/plugin-markdown-tab": "workspace:*",

diff --git a/docs/plugins/markdown/demo.snippet.md b/docs/plugins/markdown/demo.snippet.md
@@ -0,0 +1,13 @@
+## Heading 2
+
+<!-- #region snippet -->
+
+Contents containing **bolded text** and some markdown enhance features:
+
+<!-- #endregion snippet -->
+
+::: tip
+
+Hey how are **you**? :smile:
+
+:::