stdf/docs/mds/guide/mdPlugin.md

English

介绍

一款 Vite 和 Rollup 插件，功能是将 Markdown 文件转换为 HTML 字符串，基于 marked。

实现思路参考 rollup-plugin-md，增加了 TypeScript 支持。

可同时用于 Vite 和 Rollup 的插件配置。

STDF 文档站点 https://stdf.design 使用了此插件。

参数

参数	类型	默认	描述
marked	MarkedOptions	{}	marked 的配置。
include	string[]	['**/*.md']	要包含的 Markdown 文件路径。
exclude	string[]	[]	要排除的 Markdown 文件路径。

其中 include 和 exclude 是相对项目根目录（一般就是 vite.config.js 或 vite.config.ts 所在目录）的相对路径。

安装

bun add @any-tdf/vite-plugin-md-ts -D

pnpm i @any-tdf/vite-plugin-md-ts -D

npm i @any-tdf/vite-plugin-md-ts -D

yarn add @any-tdf/vite-plugin-md-ts -D

使用

在 vite.config.js 或 vite.config.ts 中配置：

import md from '@any-tdf/vite-plugin-md-ts';

export default defineConfig({
    // ...
	plugins: [
		// ...
		md({
			marked: {},
			include: [ './src/**/*.md']
		})
		// ...
	],
	// ...
});

也可以在 rollup.config.js 或 rollup.config.ts 中使用。

为何创建

其实市面上已经有很多能实现类似功能的插件，比如 vite-plugin-markdown，这些基于 markdown-it 的插件在转换待办事项列表时，并不会转换以下字符，而这个正好是 STDF 中需要用到的功能。

- [ ] 待办事项
- [x] 已完成事项

许可证

本项目基于 MIT 许可证。