Vux: API文档正在努力编写中 :fire:

Created on 30 Mar 2016  ·  17Comments  ·  Source: airyland/vux

因为模块比较多,计划在两周内写完。 :fire:

Most helpful comment

@githubxun 快了 周末基本的就写完了

All 17 comments

大神加油,我现在都是在看源码,期待API文档

@dongweizhao :smiley:

先赞一个,做得很好!最近准备在公司项目引入,用的webpack,怎么安装和引入自己项目啊,感觉这块readme里说的不是很清楚啊。。安装的话就是clone下来吗?然后require对应的模块就可以了?

@chenjiangsong 推荐从npm安装,require对应的.vue文件这样体积最小。建议先测试测试,为了统一规范,最近有比较多的属性、事件上的变更。

你好,最近一直在学习和使用vue,希望能帮上点忙。不知道文档在哪边制作?wiki?gh-page?还是新开仓库,希望能帮忙书写文档。另外关于playground也有一点想法,也希望能帮上忙。如有需要请联系

@erguotou520 playground 我完成了一个很简单的功能,主要用于根据代码把栗子嵌入文档。文档用gitbook ,我先写些基本的,下周直接放到Github协作。关于playground 的可以直接到playground的issue讨论讨论呀

@airyland 其实关于doc我更希望使用vue doc(目前好像还没有)来完成。这样不仅仅是一个项目可以用,vue的都可以用

@erguotou520 没了解过vue-doc,自动生成文档这个我也写过,提取文件的prop列表和类型自动生成,但是,如果prop的描述我想支持中英文就无解了,一些说明我也不能都写在代码里,会很杂。

@airyland 希望先给出文档和playground的仓库,我好帮忙

太好了,不过话说能否先把写好的挂出来吗?可以应对一下

@githubxun 快了 周末基本的就写完了

我表示、我是来吹文档的!

@githubxun :sweat_smile:

@airyland 今天能一睹文档的芳容吗?

@githubxun 基本的大概可以写完

image

@airyland 👍

Moved to #104

Was this page helpful?
0 / 5 - 0 ratings