@antmjs/doc

安装

yarn add @antmjs/doc
npm i @antmjs/doc

定位

antm.js Doc 是一个面向前端技术文档的框架, 以最简单、高效的方式构建技术文档。 支持h1和h3的markdown的标签形式， 即

# 大标题

### 副标题

支持常见的文档搭建需求：

• Markdown语法扩展
• 自定义全局样式
• 全文搜索

后续将支持：

• 自定义主题
• 头部导航栏菜单
• 分辨率适配
• 搜索自定义化

搜索功能

基于flexsearch实现的搜索功能

目前默认支持标题、段落和表格信息的搜索

功能特性

支持 Markdown 语法扩展

antm.js Doc 基于MarkdownItPlugin进行 Markdown 语法的扩展

详情请参考markdown 语法扩展