前端开发中，我们经常需要进行文档管理，尤其是在团队协作开发过程中。而 topdoc 就是一款 Node.js 包，可以方便地生成文档，解决了我们的一些痛点，比如减少手动编写文档的工作量，提高文档可维护性等。那该如何使用 topdoc 呢？本篇文章将为您详细介绍。
1. 安装 topdoc
使用 topdoc 之前，我们需要先用 npm 全局安装 topdoc：
npm install -g topdoc
当然，我们也可以在项目中安装 topdoc，在 package.json 中添加：
"devDependencies": {
"topdoc": "^1.1.0"
}然后在项目根目录下执行命令：
npm install
2. 编写 topdoc
接下来就可以根据项目需要编写 topdoc 了，它一般放在项目自己的目录下，比如：
project/
css/
main.css
docs/
topdoc/
index.md
index.htmltopdoc 的编写采用 markdown 格式，index.md 内容可以自定义，比如：
-- -------------------- ---- -------
- --------- ----
--------- -----------
-- ------
-------
---- ------------------
---
------Properties
{
"some-property": {
"type": "string",
"description": "..."
},
...
}Methods
-- -------------------- ---- -------
-
-------------- -
--------- -
-
------- -------
------- ---------
-------------- -----
--
---
--
---------- -
------- ---------
-------------- -----
-
--
---
-Events
-- -------------------- ---- -------
-
------------- -
--------- -
------- -
------- ---------
-------------- -----
--
---
-
--
---
-Usage
var component = new Component();
component.someMethod('arg');
component.addEventListener('some-event', function(e) {
console.log('some-event:', e.detail);
});Examples
Example 1
<div class="component"></div>
Example 2
<div class="component" data-some-property="some-value"></div>
## 3. 执行 topdoc 编写好 topdoc 后，我们在项目的根目录下执行以下命令即可生成文档：
topdoc --source docs/topdoc --output docs
-- -------------------- ---- ------- ----------- ---- ------ ----------- ------------------- ----------------- ------------------------ ------ ----- ---------- --- -- -- ---- --- ------ -------- -------- -------------------------------------------------------- -- -- -- -- ------ ----------------------------------------- ------ ------------------ - ------------------------------------------------------------------------------ -------- ------------------------------------------------------------------------------------------------------------------------