介绍
typedoc-plugin-sourcefile-url 是一款 TypDoc 插件，可以为生成的 TypeDoc 文档中的源码文件提供 URL 链接。该插件可以轻松地将文件相对于项目根目录的路径转换为 URL，并对 url 进行配置。
该插件支持以下框架和语言：
- TypeScript
- JavaScript
安装
在使用 typedoc-plugin-sourcefile-url 之前，需要先安装 typedoc。
--- ------- -- -------
然后安装 typedoc-plugin-sourcefile-url：
--- ------- ----------------------------- ----------
配置
在 tsconfig.json 文件中，添加以下配置：
-
------------------ -
-- ---
--------- -------
---------- ----
-------- -
---- -
-----------------
-------------
-
--
-- ---
--
-- ---
-在项目的根目录下添加一个 typedoc.json 文件，添加以下配置：
-
------ -------
----------- --------
---------- ----------------------
------- ----------
--------- -
-------------------------------
--
---------------------- ------------------------------------------------------------
---------------------- ---
--------- -----------
-在 typedoc.json 配置文件中，我们需要注意以下几点：
out：输出目录，也就是生成 TypeDoc 文档的目录includes：源代码目录，除了测试文件以外的文件都在这里exclude：排除的文件，可以是字符串或者正则表达式mode：文档模式，我们将其配置为module模式plugin：插件列表，我们需要添加typedoc-plugin-sourcefile-url插件sourcefileUrlPrefix和sourcefileUrlSuffix：源码 URL 的前缀和后缀，用于生成源码的 URL。我们需要将其设为我们代码托管平台的代码 URL，例如 Github。readme：要将 README.md 添加到生成的文档中，请将其设置为README.md文件的路径
使用
安装完毕，我们可以运行以下命令生成 TypeDoc 文档：
-------
此时，你将在 docs 目录下看到生成的 TypeDoc 文档，进入其中一个页面，在右上方即可看到“源代码”链接，点击即可跳转到代码托管平台的源码页面。
示例代码
以下是一段 TypeScript 代码示例，hello-world.ts：
----- ---------- -
------ ---------- -
------------------- ---------
-
-
----- ---------- - --- -------------
----------------------在 TypeDoc 生成的文档中，hello-world.ts 文件的页面中的“源代码”链接将指向 Github URL：
https://github.com/<username>/<repository>/tree/<branch>/src/hello-world.ts
即可让读者快速定位到源码位置。
总结
在本文中，我们讲解了如何使用 typedoc-plugin-sourcefile-url 为 TypeDoc 文档提供源代码链接。通过配置 tsconfig.json 和 typedoc.json 文件，我们可以轻松实现此功能。希望你能在你的前端项目中受到启发并实践。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/5eedb473b5cbfe1ea061129f