vuepress-plugin-markdown-placeholder2 v1.0.5

vuePress2.x markdown 自定义占位符替换

快速开始

使用npm安装

npm i vuepress-plugin-markdown-placeholder2 -D

开始使用和配置

使用方法

// config.js/ts
// 导入插件
import vuepressPluginMdPlaceholder from "vuepress-plugin-markdown-placeholder2";

// 配置参数 plugins: vurpressPluginMdPlaceholder({ "<BASE_URL>" : process.env.BUILD_TYPE === "github" ? "/gh/" : "/", "<CUSTOM_STR2>" : "自定义占位符2", "" : "自定义占位符3", }), ,

// markdown文件.md

...内容内容<BASE_URL>内容... ...内容内容<CUSTOM_STR2>内容... ...内容内容内容...

## 配置说明

> 本插件规定了占位符的格式是<...>，比如：<CUSTOM_STR>、<自定义占位符>、<placeholder_str>    
>     
> 并且，配置的时候，需要用引号包裹，如："<自定义占位符>"；而在markdown文件中则不用引号包裹，如：<自定义占位符>    
>     
> 可以自定义多个占位符    


### 使用技巧

> 可以配合构建变量来使用，如配置：    
>    
> "<BASE_URL>" : process.env.BUILD_TYPE === "github" ? "/gh/" : "/"    
>    
> 构建的脚本设置：    
>
> "docs:build": "vuepress-vite build src",
>
> "docs:build-github": "cross-env BUILD_TYPE=github vuepress-vite build src",
>
> "docs:dev": "vuepress-vite dev src",    
>    
> "docs:dev-github": "cross-env BUILD_TYPE=github vuepress-vite dev src",