Git Product home page Git Product logo

Comments (3)

waruqi avatar waruqi commented on June 6, 2024 1

api 的类型定义可以从 definitions 中生成,而解释说明可以从 md 里来

这样有点耦合两种工具,文档维护稍微不注意,就可能 break 两边的解析同步。。

把解释说明也放在 definitions 文件里,而 api 的文档直接从里面生成 md 或 html

暂时不打算动文档整体架构,改动太大,而且还得处理中英文同步

from xmake-docs.

LelouchHe avatar LelouchHe commented on June 6, 2024

这样的话, addon 可能就是一次性的锁定在 2.7.7

如果有后续的大的改动,再进行更新

该 addon 已经上架 LuaLS addon manager

from xmake-docs.

waruqi avatar waruqi commented on June 6, 2024

通常描述域 api 一般不会大改,问题不大。。

from xmake-docs.

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.