介绍
ember-cli-izel-docs 是一个用于生成 Ember.js 应用程序文档的 npm 包。它可以生成静态 HTML 文档，帮助开发者更好地组织和展示他们的 Ember 应用程序的代码结构、API 和文档。本文将详细介绍如何使用 ember-cli-izel-docs，包括安装和使用步骤，以及其他一些有用的技巧和建议。
安装
安装 ember-cli-izel-docs 最简单的方法是使用 npm。你可以在项目的根目录下使用以下命令：
npm install ember-cli-izel-docs --save-dev
这将安装 ember-cli-izel-docs 并将其添加到你的项目中的 package.json 文件的开发依赖中。接下来，你需要配置 ember-cli-izel-docs 以生成文档。
配置
ember-cli-izel-docs 主要使用 app 配置中的 docs 选项来确定哪些文件应包含在生成的文档中。
你需要在 Ember 应用程序的配置文件 ember-cli-build.js 中添加以下配置：
-- -------------------- ---- -------
---- --------
----- -------- - --------------------------------------------
----- ------------- - -----------------------------------------
-------------- - -------- ---------- -
--- --- - --- ------------------ -
-- --- ------- ----
---
--- ------- - -
------------ ----------
---------------- ---------------
----------- -
------------
- ----- --------------- --------- ------- --
--
--
------ -------------- --------------------------
--上述配置将文档生成到 public/docs 目录下，配置从 __dirname 指定了应用程序的根目录，还包含了 README.md 文件和 docs 目录下任何其他 Markdown 文件。
命令
ember-cli-izel-docs 有一个称为 generate-docs 的命令，可以手动启动生成的文档。
ember generate docs
这将生成文档并将其放置在配置文件中指定的输出目录中。同时也可以使用 serve 命令极为文档提供一个实时预览：
ember serve --docs
你现在可以通过访问 http://localhost:4200/docs 来查看文档。
示例
在项目根目录下创建 /docs 文件夹。
在该文件夹下创建 index.md 和 installation.md 目录，并添加以下内容：
/docs/index.md
-- -------------------- ---- ------- - ----- ------- ------- -- --- ----- ------- -------------- --- ---- -- ---- -------- -- -- ------- --- ---- ---------- --- --- --------- -- ----- -------- -- --- -- ------ --- ----- ---- ---- --- ---- --- --------- ---------- - ------- -- -- ----- - --- -- -- ----- -- ------------ -- -------- -- ----- ---- ---------- -- --- ---- -------- -- --- ------ ------ -- ----- ---- --- ------- -- -----------------------
/docs/installation.md
-- -------------------- ---- ------- - ------------ -- ------- ------- -- --- ------- ------- --------- ------- -- ---- -------- ------ -- -- -- -------- --- -------- ------- ------- --------------------------------- -- ------- ----- --- -- ------- ----- ---- ---- ---- -------- --- ------
npm install -g ember-cli
This command installs Ember CLI globally on your machine.
在 ember-cli-build.js 文件中的开发者 app 对象中添加以下代码：
-- -------------------- ---- -------
--- ------- - -
------------ ----------
---------------- ---------------
----------- -
------------
- ----- --------------- --------- ------- --
--
--
------ -------------- --------------------------现在运行以下命令，以生成和启动文档：
ember generate docs ember serve --docs
请在浏览器中访问 http://localhost:4200/docs，以查看文档的实时预览。
##小结
本文介绍了如何使用 ember-cli-izel-docs 生成静态HTML文档。通过这些步骤，你将能够更好地组织和展示你的 Ember 应用程序的代码结构、API 和文档。对于需要保存和共享文档的团队来说，这是一个非常有用的工具。我们希望这篇文章对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005671381e8991b448e361a