背景
对于前端开发者来说,平时在工作中使用的组件库很多时候是自己团队内部所开发的。因此,为了能够更好地展示组件库内的组件和方便其他团队成员的使用和了解,我们需要一个工具去对每个组件进行文档的编写和展示,于是 ember-cli-addon-docs 应运而生。
ember-cli-addon-docs 是一个基于 Ember.js 的 npm 包,可以帮助我们快速编写和展示组件库中的组件文档。
安装
在使用 ember-cli-addon-docs 之前,需要先在你的项目中安装 Ember.js,安装命令如下:
--- ------- -- --------- ----- --- ------------
接下来,在项目根目录下执行以下命令安装 ember-cli-addon-docs:
----- ------- --------------------
这一步完成后,我们可以在项目目录下看到一个 docs
目录,这个目录就是用来存放组件文档的。
使用
编写文档
在 docs 目录下创建一个 .md
文件,编写组件文档,格式如下:
----- ------------------------- ---- ----- ------ ---- ------- ----- ---------- ---- -- ----- ---- ----- --------- ---- ------ ---------------------
{{!-- 对组件的 API 进行描述 --}}
API
属性列表:
foo
- 组件参数 A。bar
- 组件参数 B。
-------------------------- ---------- --- --------- - ----- ---------- --- -- ---------------
ember serve
------------- ---------------------------- ---------------- --- -- ------------------------ ----- ----------------------------
ember addon
--------- ----------------- ----------------------- ------------- -------------------- ------------------------ -------------------- ----- ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------