stdf/docs/mds/guide/mdPlugin_en.md

简体中文

Introduction

This is a Vite and Rollup plugin that converts Markdown files to HTML strings, based on marked.

The implementation idea is based on rollup-plugin-md, adding TypeScript support.

The STDF doc site https://stdf.design uses this plugin.

Parameters

Parameter	Type	Default	Description
marked	MarkedOptions	{}	marked options.
include	string[]	['**/*.md']	The path of the Markdown file to include.
exclude	string[]	[]	The path of the Markdown file to exclude.

The include and exclude parameters are relative to the project root directory (usually the directory where vite.config.js or vite.config.ts is located).

Installation

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

Usage

Configure in vite.config.js or vite.config.ts:

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

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

It also works in rollup.config.js or rollup.config.ts with the same plugin.

Why Create

There are already many plugins that can implement similar functions, such as vite-plugin-markdown, which do not convert the following characters when converting to-do lists, which is exactly the function needed in STDF.

- [ ] TODO
- [x] DONE

License

This project is licensed under the MIT License.