介绍
@polymer/iron-component-page 是一个以 Polymer 为基础的 Web Component，用于生成一个完整的文档页面。它提供了导航、搜索、示例代码和文档等功能，使得文档编写更为高效和美观。
安装
你可以通过以下命令安装 @polymer/iron-component-page：
npm install --save @polymer/iron-component-page
使用
基本使用
在你的 HTML 文件中引入 @polymer/iron-component-page：
-- -------------------- ---- -------
--------- -----
----- ----------
------
----- ----------------
-------------------------- ------------
------- ------------- ----------------------------------------------------------------------------------
-------
------
---------------------
--- -------------------- -----------
-------- ------------
----------- ------------
------- ---- --------- ---- --------
----------
----------------------
-------
-------接下来，打开网页，就可以看到一个带有导航栏和文档页面的页面了。
带有示例代码
@polymer/iron-component-page 还支持在文档中插入带有示例代码的 Demo。
-- -------------------- ---- -------
--------- -----
----- ----------
------
----- ----------------
-------------------------- ---- ---- ---- ------------
------- ------------- ----------------------------------------------------------------------------------
-------
------
---------------------
--- -------------------- -----------
-------- ------------
----------- ------------
------- ---- --------- ---- --------
-------------
----- ------------
----------
------------- ------------
-----------
--------
----- ------ - --------------------------------
-------------------------------- -- -- -
------------- --------
--
---------
-------
----------
----------------------
-------
-------这样，我们就能在文档页面上看到一个示例按钮，并点击按钮后弹出 "Hello, world!" 的弹窗。
带有 api 文档
如果需要在 document 页面上提供 API 文档，可以使用相应的代码块 template，示例代码如下：
-- -------------------- ---- -------
----------- ---------- -------------------
------- ------------------------
-
------------- -
-
------- -----------
------- ----------
-------------- ------------
--
-
------- ---------
------- ----------
-------------- ------------------
-
-
-
---------
-------------总结
@polymer/iron-component-page 提供了一个快速和美观的方式来构建文档页面，并提供了示例代码和 api 文档，使得文档编写更为高效和美观。我相信在你的项目中，@polymer/iron-component-page 能够成为文档编写的好帮手。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f75556da9b7065299ccbca5