md-tools-theme-multi-component-react

md-tools的一个React组件库文档系统

Usage no npm install needed!

<script type="module">
  import mdToolsThemeMultiComponentReact from 'https://cdn.skypack.dev/md-tools-theme-multi-component-react';
</script>

README

md-tools-theme-multi-component-react

依赖 fish 库开发的md-tools的一个主题,用于展示组件库文档和示例

Usage

  1. 安装依赖:
npm i -D md-tools-theme-multi-component-react
  1. md-tools.config.js中配置主题:
{
  theme: 'md-tools-theme-multi-component-react',
  ...
}
  1. 使用此主题构建文档的项目,需注意事项
  • 必须有 README.md 和 CHANGELOG.MD 两个 md 文件
  • 源码必须放 components 目录下

4.使用方提供主题配置文件 theme.config.js

Liscense

MIT