docz 强大简单的文档管理工具

使用docz咱们能够用来方便的编写以及发布文档,同时提供漂亮友好的交互,能够快速的制做一个产品级的
站点,使用了了mdx 文件(仍是markdown),同时能够方便的集成到本身的web 项目中git

安装试用

  • 安装
 
npx create-docz-app my-docz-app
  • 项目结构
├── README.md
├── doczrc.js
├── package-lock.json
├── package.json
└── src
    ├── components
    ├── Alert.jsx
    └── Alert.mdx
    └── index.mdx
  • 启动效果
yarn dev

错误解决

目前在使用mac 安装的时候碰到几个问题
libvips, 主要是 由于依赖sharp 引发的github

 
 CXX(target) Release/obj.target/sharp/src/common.o
../src/common.cc:25:10: fatal error: 'vips/vips8' file not found
#include <vips/vips8>
 

解决方法:web

brew install vips

说明

idyll 也是一个相似不错的东西,可是idyll偏向于科学分析json

参考资料

https://github.com/doczjs/docz
https://github.com/idyll-lang/idyllmarkdown

相关文章
相关标签/搜索