类型doc 是一个包装插件,用于 Nx 工作空间 快速设置您的项目的文档自动化 类型doc它由一群热情的个人根据麻省理工学院的许可创建、维护和作为开源发布 埃尼奥。 。 。 .
安装,运行它!
如果你不熟悉打字机, 说打字机是方便的是一个低调的。 如果您正在正确使用 TypeScript, 指定类型和界面, 并评论您的代码所做的事情 - 您可以在一个静态站点生成文档 .
Kudos 给作者和维护者 优秀的图书馆。我们创建了这个 Nx 包装器插件,以解决我们的问题 - 维护几个开源项目并不容易,当然,任何使代码基础可以维护的自动化都是最受欢迎的.
检查此快速演示如何通过此插件设置类型文件并使用 :
开始
- 将插件添加到您的 Nx 工作空间 :
npm install --save-dev @enio.ai/typedoc
- 在您工作空间的根目录中运行以下命令, 其中
<project>是您想要设置的 nx 工作空间中的工程名称 。 若为nx不是设置全局, 您可能想要先将其添加为 npm 脚本( 详见下面) 或前缀npx使用时 无。您也可以从 Nx 控制台 扩展名 虚拟系统。 。 。 .
nx g @enio.ai/typedoc:config <project>
生成文档
运行以下命令, 在哪里 <project> 是 nx 工作空间中您工程的名称.
npx nx run <project>:typedoc
可选的, 您可以在 : package.json 为方便起见,将文件放在您 nx 工作空间的根文件夹中.
{
"scripts": {
"create.docs": "nx typedoc",
"setup.docs": "nx g @enio.ai/typedoc:config"
}
}
然后你可以运行命令:
// Generating documentation
npm run create.docs <project>
// Setting up typedoc in your project
npm run setup.docs <project>
默认情况下,文档生成于: ./docs 相对工作空间的根目录.
配置文档
此插件包括用于最佳体验的合理默认配置 . 如果您希望在您的 Nx 项目中进一步自定义类型文档行为, 您可以 ;
- 更新
typedoc.json文件在您的工程目录中. - 更新类型文件条目选项
nx.json在运行您的 Nx 项目生成文档命令时应用一致的行为.
贡献者
发起人
所有捐助者和赞助者都能够维持这一项目。 如果您愿意赞助这个项目, 请将您的相片或公司标志显示在下面 点击这里。 。 。
(此列表会在未来自动生成. )