规范

  • 提交一个库

    Step 1

    需要新建库目录及其版本目录,并将文件放在相应目录下,最后补全package.json文件。

    ├── backbone.js               # ... library
    │   ├── 1.1.0                 # ... version
    │   |   └── backbone.js       # ... fileanme
    │   └── 1.1.1
    │       └── backbone.js
    └── package.json              # ... package.json
    
    			
    

    Step 2

    编辑packag

  • 开篇我声明,是写入门教程的套路,并不是所有的教程都是如此。不喜勿喷..

    我总结了下,入门教程要想写的好(被人点的赞多),首先我们得清楚看这个入门教程的人想知道什么。其实,无非就是三点:

    1. 什么是xx?
    2. xx主要包含什么内容?
    3. 怎么使用?

    什么是xx?

    入门教程第一个标题一般就是,什么是xx?那么回答这个问题,核心描述一定得抓住

    核心要浅显易懂,要直入主题,一定不要搞一些复杂的专有名词(个人认为就是装X),不要说的花里胡哨。最好就是一句话。

    这里我举了两个例子,比如:

    MobX只做一件事,解决 state 到 view 的数据更新问题

    还有一个例子:

    MobX 是一个简单、方便扩展、

  • 快速初始化标准项目工程

    首先下载 ucf-cli 命令行工具,通过一行命令快速生成标准工程:

    $ npm install ucf-cli -g
    

    执行初始化:

    $ ucf init walsin-webapp
    

    获得标准项目代码:

    walsin-webapp
    ├── .gitignore
    ├── LICENSE
    ├── README.md
    ├── package.json
    ├── ucf-apps
    ├── ucf-common
    ├── ucf-public
    └── ucf.config.js
    

    对标准项目工程的解读和认识

    walsin-webapp
    ├── package.json
    ├── u