在前端开发中，我们经常使用 TypeScript 编写代码，并将其编译为 JavaScript 运行在浏览器上。在编写 TypeScript 代码时，我们通常会添加注释来描述函数、接口和类等的使用方法和作用。但是，在将 TypeScript 代码编译为文档时，我们通常需要使用 TypeScript 的文档生成工具 TypeDoc 来生成静态文档。
然而，当我们使用 GitHub Pages 等服务来展示我们的文档时，文档往往不能正常显示，这是因为这些服务没有启用 Jekyll，而 TypeDoc 生成的文档默认需要 Jekyll 支持。为了解决这个问题，我们可以使用 npm 包 typedoc-plugin-nojekyll。
typedoc-plugin-nojekyll 是什么？
typedoc-plugin-nojekyll 是一个 TypeDoc 插件，它提供了一种简单的方法来生成可以在没有 Jekyll 支持的静态托管服务上正常显示的文档。
使用 typedoc-plugin-nojekyll 生成的文档可以免受 GitHub Pages 等服务缺乏 Jekyll 支持的影响，可以更好地展示我们的文档。
如何使用 typedoc-plugin-nojekyll？
要使用 typedoc-plugin-nojekyll，我们需要先安装 TypeDoc 和 typedoc-plugin-nojekyll：
npm install -g typedoc npm install --save-dev typedoc-plugin-nojekyll
然后，在我们的 TypeScript 项目中运行以下命令来生成文档：
typedoc --out docs --plugin typedoc-plugin-nojekyll
这个命令会将生成的文档输出到 docs 目录中，并使用 typedoc-plugin-nojekyll 插件来生成可以在 GitHub Pages 等服务上正常显示的文档。
typedoc-plugin-nojekyll 示例
考虑以下 TypeScript 例子：
-- -------------------- ---- ------- --- - --------- - -- ----- -- ------ --------- ----- - --- - --- - ---------- -- -- ------- --- - --- - ---------- -- -- ------- - --- - ---------- --- -------- ------- --- ------- - ------ ------- ----- --- ----- ------ - ------ ------- ------ --- ------ ------ - -------- -------- --- -------- ------- --- --- ------- -- ------ -------- --------------- ------ ------- ------- ------ - ----- ------ - -------- - -------- ----- ------ - -------- - -------- ------ ---------------- - ------ - ------ - -------- -
我们可以使用 typedoc-plugin-nojekyll 来生成这个模块的文档。首先，我们需要在项目根目录下创建一个 docs 目录：
mkdir docs
然后，在项目根目录下运行以下命令来生成文档：
typedoc --out docs --plugin typedoc-plugin-nojekyll
这个命令会将生成的文档输出到 docs 目录中，我们可以在浏览器中打开 docs/index.html 来查看生成的文档。现在，我们可以在 GitHub Pages 等服务上展示这个文档，而无需担心 Jekyll 不支持的问题。
结论
以上是 typedoc-plugin-nojekyll 的使用教程，该插件提供了一种简单的方法来生成可以在没有 Jekyll 支持的静态托管服务上正常显示的文档。使用 typedoc-plugin-nojekyll，我们可以更好地展示我们的文档，以及在不同的环境下使用 TypeScript 来开发应用程序。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/typedoc-plugin-nojekyll