GithubHelp home page GithubHelp logo

Comments (3)

catouse avatar catouse commented on May 22, 2024

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 任务来构建文档资源。

from zui.

scm-Q avatar scm-Q commented on May 22, 2024

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

from zui.

catouse avatar catouse commented on May 22, 2024

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

from zui.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.