Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 2.59 KB

README_zh-CN.md

File metadata and controls

74 lines (48 loc) · 2.59 KB

一款支持通过 JSX 来编写 Markdown 的工具

English | 简体中文

npm-version npm-download codecov github-starsdemo

目录

愿景
特性
Live Demo
原理
帮助文档
License

愿景

为了让通过 JSX 来编写 Markdown 成为件轻松且愉快的事😄💪🏻

特性

  • 提供渲染生成 Markdown 语法内容的基础组件
  • 实时渲染生成
  • 支持原生 HTML
  • 支持多个文档同时渲染
  • 支持生成目录
  • 支持异步渲染

Live Demo

原理

该库主要由两部分构成

  • 命令行工具
  • 函数API

命令行工具:解析配置文件、执行 render 逻辑,最后生成 Markdown 文件

函数API:提供对标 Markdown 语法的基础组件及 render 函数

  • 基础组件:用于替代 Markdown 语法的基础组件
  • render 函数:渲染 JSX 编写的内容,返回生成的字符内容

所以 命令行工具函数API 这两者搭配使用效果更佳

帮助文档

License

MIT

Copyright (c) 2022-present Eyelly Wu