介绍
众所周知，aglio 是一个很好的 API 文档生成工具。在其中，有一款叫做 aglio-theme-olio-attributes 的主题，它可以帮助我们在规范 API 文档的同时，更好地展示接口的属性信息。这篇文章主要介绍 aglio-theme-olio-attributes 的使用方法。
安装
如果你已经安装了 aglio，你只需要在你的项目目录下输入以下命令即可安装 aglio-theme-olio-attributes：
npm install aglio-theme-olio-attributes --save
引入
在安装完成后，你可以将 aglio-theme-olio-attributes 作为主题引入 aglio，只需使用运行 aglio 时的 --theme 设置参数即可，如下所示：
aglio -i in.md -o out.html --theme-attributes aglio-theme-olio-attributes
使用
在我们的 API 文档中，数据的属性通常含有以下几个信息：
- 名称
- 类型
- 描述
- 默认值
- 必选项
aglio-theme-olio-attributes 正是为这些属性信息而生的主题。对于每个数据属性，你需要在 Markdown 中进行表达，具体如下：
-- -------------------- ---- -------
-- ---
--- -------- -----------
---- -------- ------
- -------
- ----------
- ---------- -------- ---------- ---------- -----------
- ---------- --------- ---------- -----------
- ---------- ------- ---------- ---------- -----------通过这样的表达方式，aglio-theme-olio-attributes 将会自动地去解析和展示出每个属性的信息，一目了然。
示例代码
下面是一份示例代码，供大家参考。
-- -------------------- ---- -------
- -- ---
-- -------------- ---------------
--- ------------ ------
- -------
- ----------
- -------- -------- ---------- --- ------ --------
- -------- -------- ---------- --- ------ --------
- -------- --- ------------------
- ----------
- ----- --------- --- -------------- -----
- ------- ---------- --- ---------- ---- -- --- ----- -- ---- --------- ------
--- ----- ------
- -------
- -------
- -------------- --- ---- ----- ----- -- ------
- -------- --- ------------------
- ----------
- ----- --------- --- ------- -------------- -----
- ------- ---------- --- ---------- ---- -- --- ----- -- ---- --------- ------
-- ----- --------
--- ------ ---- ------
- -------
- ----------
- ---- -------- ---------- --- ------ ----
- --- ---------- --- ------ ---
- ----- --------- --- ------ ----- -------
- ------- --------- --- ------ -------
- -------- --- ------------------
- ----------
- -- ---------- --- ------ --
- ---- --------- --- ------ ----
- --- ---------- --- ------ ---
- ----- --------- --- ------ ----- -------
- ------- --------- --- ------ -------
--- --- ---- ---- ------------
- ----------
- -- --------- ---------- --- ------ --
- -------- --- ------------------
- ----------
- -- ---------- --- ------ --
- ---- --------- --- ------ ----
- --- ---------- --- ------ ---
- ----- --------- --- ------ ----- -------
- ------- --------- --- ------ -------
--- ------ ---- ---- ------------
- ----------
- -- --------- ---------- --- ------ --
- -------
- ----------
- ---- --------- --- ------ ----
- --- ---------- --- ------ ---
- ----- --------- --- ------ ----- -------
- ------- --------- --- ------ -------
- -------- --- ------------------
- ----------
- -- ---------- --- ------ --
- ---- --------- --- ------ ----
- --- ---------- --- ------ ---
- ----- --------- --- ------ ----- -------
- ------- --------- --- ------ -------
--- ------ ---- ------- ------------
- ----------
- -- --------- ---------- --- ------ --
- -------- ---
结论
以上就是 aglio-theme-olio-attributes 的使用方法了，这个主题可以帮助我们更好地展示 API 文档中的属性信息，让 API 文档更加规范化和易读。希望本文可以对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055eb781e8991b448dc69b