简体中文

Introduction

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

The implementation idea is based on rollup-plugin-md, adding TypeScript and compatible with Vite's plugin type.

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

pnpm i rollup-plugin-md-ts -D

npm i rollup-plugin-md-ts -D

bun add rollup-plugin-md-ts -D

yarn add rollup-plugin-md-ts -D

Usage

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

import md from 'rollup-plugin-md-ts';

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

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. Feel free to enjoy and contribute to this open source project.