Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

文档的生成构建是不是没开源呢 #40

Closed
scm-Q opened this issue Nov 25, 2016 · 3 comments
Closed

文档的生成构建是不是没开源呢 #40

scm-Q opened this issue Nov 25, 2016 · 3 comments

Comments

@scm-Q
Copy link

scm-Q commented Nov 25, 2016

对于init.json的生成感兴趣,这部分是否可以共享,谢谢。

@catouse
Copy link
Collaborator

catouse commented Nov 26, 2016

ZUI 中并没有 init.json 文件,文档网站使用到的两个 JSON 文件包括:

  • /zui.json:此文件包含了 ZUI 中所保护的所有组件的相关信息,及 gulp 构建任务配置信息,在文档网站上会读取改文件显示各组件的依赖关系和源码信息;
  • /docs/index.json:此文件包含文档章节和目录相关信息。

/zui.json/docs/index.json 都是手工录入,并非自动生成。

如果你要构建自己的文档网站,你需要关注以下文件:

  • /docs/index.json
  • /src/js/doc.js
  • /src/less/doc.less
  • /index.html

使用 gulp doc 任务来构建文档资源。

@scm-Q
Copy link
Author

scm-Q commented Nov 26, 2016

我现在在整的框架,文档部分借鉴了你的实现;展示效果不错;在此先感谢;index.json的手动维护,打算写个g runt插件来动态解析.md文件生成;

@catouse
Copy link
Collaborator

catouse commented Nov 26, 2016

嗯,我也是打算根据 .md 文件中的信息生成目录,并根据目录生成最终静态 html 文档,而不是现在在网站上加载 .md 文件再转换为 HTML。

@catouse catouse closed this as completed Nov 26, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants