docs
活跃·★ 120·MIT·更新于 2026-10-13
这是一个命令行界面(CLI)工具,旨在与基于MDX的文档进行交互和构建。它允许用户直接在终端中阅读、搜索和导航文档,并提供将MDX编译成各种格式(包括HTML片段和完整的静态网站)的功能。
#命令行工具#文档#MDX#静态站点生成#开发工具#内容管理#终端界面
01
功能特性
01通过键盘控制在终端中阅读和导航文档
02跨多个文档库或特定页面进行搜索
03将MDX内容构建为HTML片段或完整的静态网站
04在兼容的终端模拟器中支持OSC 8超链接
05缓存已获取的文档一小时以加快访问速度
02
兼容性
Node.js
运行时
已通过文档验证
Terminal
环境
已通过文档验证
MDX
格式
已通过文档验证
Web Browser
输出
已通过文档验证
03
快速开始
1
$ npx @pmndrs/docs
04
使用场景
↳在开发过程中快速访问和浏览项目文档
↳生成静态文档站点以进行发布和部署
↳将文档构建过程集成到CI/CD流水线中
↳自动化将MDX内容转换为各种Web格式
05
同类工具
评论
登录后发表评论
暂无评论,来发表第一条吧