是一款基于React的开源文档框架,可以帮助开发者快速构建文档网站,它可以将开发者的代码和注释渲染成完整的文档网站。
官方文档:Docz
目录
基础使用
1. 首先将docz添加为依赖项:npm install docz
注意:确保安装了react,且react-dom >= 16.8.0
安装后package.json:
{
// 可选步骤 start
"name" : "next-gen-documentation" ,
"scripts" : {
"docz:dev" : "docz dev" ,
"docz:build" : "docz build" ,
"docz:serve" : "docz build && docz serve"
} ,
// 可选步骤 end
"dependencies": {
"docz": "^2.4.0",
"react": "16.8.0",
"react-dom": "16.8.0"
}
}
2. 启动:npm run docz:dev
3. 开发