Markdown Include
Overview
Import content from other markdown files within Markdown files.
Related plugin: @vuepress/plugin-markdown-include
Configuration
The theme enables markdownInclude by default. You can further customize its behavior through configuration.
import { defineUserConfig } from 'vuepress'
import { plumeTheme } from 'vuepress-theme-plume'
export default defineUserConfig({
theme: plumeTheme({
markdown: {
include: {
// ... options
},
},
}),
})For configuration entry priority information, please refer to Plugin Configuration Entry.
resolvePath
- Type:
(path: string, cwd: string | null) => string - Default:
(path) => path - Details: Processes the include file path.
deep
- Type:
boolean - Default:
false - Details: Whether to recursively import
@includewithin included files. Whenfalse, the@includein included files will not be further parsed.
useComment
- Type:
boolean - Default:
true - Details: Whether to use
<!-- @include: xxx -->instead of@include: xxxfor file inclusion.
resolveImagePath
- Type:
boolean - Default:
true - Details: Whether to resolve relative image paths within the included Markdown files.
resolveLinkPath
- Type:
boolean - Default:
true - Details: Whether to resolve relative file paths within the included Markdown files.
