Theme for apollo Documentation
这是一个为 apollo 文档设计的 nico 主题。
安装
1. 安装 node
请自己安装 node。版本 >= 0.10.1
2. 安装
$ npm install apollo-nico -g
3. 功能强化
安装 socket.io 后，将具有 liveloader 的功能
$ npm install socket.io -g
使用
apollo-nico init [name]
$ apollo-nico init
或者：
$ apollo-nico init button
等价于
$ mkdir button
$ cd button
$ apollo-nico init
- 该命令会在符合目录规范(apollo/mod/xxx|apollo/mod/core) 的路径下生成组件所需的README.md, package.json, HISTORY.md
文件说明：
-
README.md： 当前组件的文档
若需要演示和代码示例，可使用以下文档结构书写：### Button <div class="apollo-demo demo-button"> <div class="demo-show" > ####示例代码写在这里,且复制代码功能会复制这里的代码。#### <button class="ui-button ui-button-primary ui-button-small">primary small</button></div> <div class="demo-code"> </div> </div> ```html ####查看代码功能所显示的代码片段#### <button class="ui-button ui-button-primary ui-button-small">primary small</button> ``` -
package.json： 当前组件的配置文件，包括作者、组件地址、版本、描述信息：
- family： 组件从属的目录的上级目录
- name： 组件名称 (default:当前目录名称)
- version： 当前版本号 (default:1.0.0)
- keywords： 关键词
- description： 简短描述
- homepage：组件主页(default:自动生成)
- author： 作者信息(请使用作者的内网主页地址)
- bugs： 提交bug地址(默认为gitlab)
- modURL： 组件的源文件地址(自动生成)
- atomSc： atom地址(自动生成)
- dependentStyle: 该组件所依赖的其他组件样式，会在生成静态站点时自动引入。参考form组件
-
HISTORY.md： 组件的版本历史信息
apollo-nico
$ apollo-nico
- 该命令会当前文档目录下，生成一个
http://127.0.0.1:8000/的服务器，可以对 文档，demo，单元测试 等进行调试。 - 当前目录下必须存在 README.MD, package.json 这两个文件。
- 将README.MD编译为html文件，并自动启动浏览器打开
http://127.0.0.1:8000/，预览该html文件。 - 此时修改README.MD文件，
http://127.0.0.1:8000/即时生效。
apollo-nico build
$ apollo-nico build
- 在当前文档目录下，生成
_site目录，里面存储生成的静态站点。也会编译所有的sass文件 - 注意：使用
apollo-nico命令虽然会打开预览，但不会将生成的静态站点复制到当前目录下，所以需要使用apollo-nico build来生成静态站点，并复制到当前目录下。
$ apollo-nico build /a
- 会将当前目录下的所有包含
README.md,package.json的目录批量生成静态站点，并存放于相应的子目录下。
apollo-nico sass
$ apollo-nico sass _text.scss
可以编译目录下面的_text.scss文件，输出text.css文件.输入apollo-nico sass text 也可以
Markdown 语法
这里使用的 markdown 及 文章结构语法请参考该文档 http://lab.lepture.com/nico/zh/syntax