typeDoc使用记录

最新推荐文章于 2024-05-11 09:36:04 发布
最新推荐文章于 2024-05-11 09:36:04 发布
阅读量1.5k 收藏
点赞数
分类专栏： ReactJs 前端 踩坑系列 文章标签： typescript
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_43264596/article/details/107758245
版权
ReactJs 同时被 3 个专栏收录
21 篇文章 0 订阅
订阅专栏
踩坑系列
7 篇文章 0 订阅
订阅专栏
前端
6 篇文章 0 订阅
订阅专栏

我使用的是gulp-typedoc
gulp-typedoc
参考文档
typescript文档化工具——Typedoc
记录坑
1、在这里插入图片描述
找不到typescript模块 但是 我用yarn typescript -v 是可以看到typescript的版本号的
然后我就尝试重新 yarn add typescript 安装完成后重新 yarn gulp typedoc 结果就成功了
在这里插入图片描述
就能狗看到根目录有了doc文件夹 打开以后是
在这里插入图片描述
点击globals.html就能看到我们用typescript编写的函数了（我随便写的因为是测试能看到效果就可）

在这里插入图片描述

百奇
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
typedoc:typedoc原始码阅读
03-23
类型文档 typedoc原始码阅读
TypeDoc: 一款TypeScript项目文档生成器
清晨-阳光的博客
12-23 4824
TypeDoc：一款TypeScript项目文档生成器
探索TypeDoc：TypeScript项目的文档生成器
最新发布
gitblog_00075的博客
05-11 336
探索TypeDoc：TypeScript项目的文档生成器 项目地址:https://gitcode.com/TypeStrong/typedoc 项目介绍 TypeDoc是一款专为TypeScript项目设计的文档生成工具，它能够从源代码中提取类型信息，并以清晰、结构化的形式呈现出来。项目提供了命令行接口，便于集成到构建流程中，同时也支持自定义主题和配置选项，让你的API文档拥有专业且个性化的外观...
TypeScript 文档化工具: typedoc
晴树的专栏
07-14 8799
http://www.xdnote.com/typedoc/ 由于目前主要前端语言由JavaScript切换到了TypeScript，所以原先用的JSDoc工具也用不了了，虽说JSDoc官方也在积极适配TypeScript，但始终产品不能等工具。何况不是核心的文档功能。 于是上Github上找了一下，很快发现了以下项目： TSDoc typescript-docs ts2jsd...
typedoc-site:TypeDoc网站
04-03
TypeDoc主页 包含的内容。 GitHub页面使用_site/文件夹从gh-pages分支渲染网站。 报告问题 请向库报告问题，以获得更好的可见性。 写作指南 指南存储在guides/目录中，并用Markdown编写。 每个文件应包含以下带有适当标题和菜单顺序的标题部分。 --- layout: 'guide' title: 'Installation' menuOrder: 1 --- 在本地建立网站 npm i npm run build --serve 要重新生成_site/api/文件夹，请在此处克隆typedoc存储库，然后运行： cd typedoc npm i npm run build node bin/typedoc --options ../typedoc.json 如果自上次更新以来已添加了新选项，请运行以下命令以更新typedoc.json模式： no
typedoc：TypeScript项目的文档生成器
02-05
TypeDoc TypeScript项目的文档生成器。 文献资料 有关更详细的文档以及使用TypeDoc呈现的TypeDoc文档，请参见 。 安装 TypeDoc在Node.js上运行，可作为NPM软件包使用。 npm install typedoc --save-dev 用法 要生成文档，TypeDoc需要知道您的项目入口点和TypeScript编译器选项。 它将自动尝试查找tsconfig.json文件，因此您只需指定库的入口点即可： typedoc src/index.ts 如果您有多个入口点，请指定每个入口点。 如果指定目录，TypeDoc会将其中包含的每个文件视为入口点。 t
使用typescript改造koa开发框架的实现
10-15
- 使用 JSDoc 或 TypeDoc 生成 API 文档，方便团队成员理解和使用。 7. **持续集成/持续部署 (CI/CD)**： - 配置 CI/CD 工具，如 GitHub Actions 或 Jenkins，集成测试和部署流程，确保每次提交都能通过类型检查...
node-skeleton:与Typescript，Docker，Kubernetes，PM2，Eslint，Prettier，VSCode配置，Winston，Typedoc，Nodemon，AVA，PromClient，JWT，Editorconfig，OpenAPISwagger，JaegerOpen跟踪等打包在一起的Node.js样板
03-05
与Typescript，Docker，Kubernetes，PM2，Eslint，Prettier，VSCode配置，Winston，Typedoc，Nodemon，AVA，PromClient，JWT，Editorconfig，OpenAPI / Swagger，Jaeger / Open Tracing等打包在一起。 该项目背后的...
taquito：一个在Tezos区块链上构建dApp的库-JavaScript TypeScript
02-11
用于在Tezos区块链上开发的...良好的支持Taquito随附： 使用TypeDoc记录良好的API 针对Tezos节点的夜间和持续集成测试版本发布到npmjs.org项目组织taquito被组织为一个Mono仓库，从中构建和发布了几个npm软件包。 软
m-ld-spec:独立于平台的 m-ld 规范
07-24
网站该使用 typedoc 构建，并传送到规范文档网站 。类型发动机API被部分指定为使用打字稿作为一个抽象的规范语言。 请注意，引擎实现不会直接使用这些类型，因为它们是有意为高级别的，并且与平台细节（例如线程模型...
recurring-functions
03-25
他们还记录了使用typedoc自动补全的情况。 在每个功能中可以找到更多信息或积分。addToArrayIfNotExists 如果值不存在（没有对象），则将值添加到数组； import { addToArrayIfNotExists } from 'recurring-...
typedoc_docusaurus
04-04
TypeDoc- Docusarus概念证明 该文档是使用Docusarus和TypeDoc自动生成的。 效果很好。 尽管默认的TypeDoc输出不带文档，但效果很好。 开箱即用的TypeDoc具有一个不错的搜索界面。 Docusaurus增加了为某些页面添加更多手写文档的能力。 但是我认为通常也可以使用noraml TypeDoc来完成。
typedoc-plugin-lerna-packages:用于Typedoc的插件，可将所有Lerna软件包分组到自己的TS模块中
05-22
typedoc-plugin-lerna-packages 用于的插件，将所有Lerna软件包分组到自己的TS模块中。 通常，Typedoc将每个文件作为模块来处理，这对于lerna软件包是不正确的，因为每个软件包都应被视为模块。 这个插件可以解决这个问题。 另外，如果您的程序包文件夹中有README.md，它将用作该模块的注释。 示例示例： : 示例源代码： : 只需安装它并输入typedoc ： npm i -D typedoc-plugin-lerna-packages typedoc@~0.16 # yarn add -D typedoc-plugin-lerna-packages typedoc@0.16 --tilde npx typedoc # yarn typedoc 根文件夹中的示例typedoc.js module . exports = {
jsdoc-tsd:JSDoc模板，用于基于JSDoc注释生成TypeScript定义文件
05-24
jsdoc-tsd 安装 您可以从npm安装此模块： $> npm install @otris/jsdoc-tsd 用法 要使用此模块，只需将这个项目指定为jsdoc输出的模板。 要从命令行使用此模板，请运行 $> jsdoc -t node_modules/@otris/jsdoc-tsd -r . 您还可以将此模板添加到JSON配置文件中： { "opts": { "template": "./node_modules/@otris/jsdoc-tsd" } } 输出目录/文件 要确定输出目录和/或输出文件名，可以按以下方式将路径或文件名传递给cmd调用： $> jsdoc -d <target>/<filename>.d.ts 重要提示：如果要更改结果文件的文件名，则路径必须以d.ts结尾的文件结尾 选项 ignoreScope
typedoc:Deno API-简体中文
04-13
Deno API 简体中文版 Deno 简体中文 API 参考手册。本文档是非官方 Deno 简体中文文档，由中文开发者社区的志愿者们维护。 本文档使用了 主题和 插件，为文档提供了中英文对照功能。 实用命令 yarn format: 整理文件格式。所有文件格式均使用 prettier 的默认配置。如果没有特殊必要，你基本上不需要手动运行此命令。当 git commit 的时候此命令会自动运行。 yarn build: 生成 typedoc 文件。你可以通过在浏览器中打开 ./typedoc/index.html 来预览最终的生成效果。 参与翻译 翻译规范请参阅 版权许可 本文档采用 许可协议。
gulp-typedoc-extractor:从gulp-typedoc json输出中提取模块的后处理器
05-14
gulp-typedoc提取器 从gulp-typedoc json输出中提取模块的后处理器。 用法 首先，安装gulp-typedoc-extractor作为开发依赖项： npm install --save-dev gulp-typedoc-extractor 然后，将其添加到您的gulpfile.js ： 提取模块 var extractModule = require ( 'gulp-typedoc-extractor' ) ; gulp . task ( 'extract-module' , function ( ) { gulp . src ( [ 'dest/full-api.json' ] ) . pipe ( extractModule ( 'aurelia-framework' ) ) . pipe ( gulp . dest ( 'dest/a
Typedoc + Vitepress 自动生成 typescript 项目文档
qq_31694733的博客
09-28 445
使用vitepress + typedoc 为typescript项目自动一键生成文档
typescript文档化工具——Typedoc
weixin_34061555的博客
10-22 2374
Typedoc 简介： Typedoc 是一个 TypeScript 语言的文档生成工具，类比 jsdoc。 构建出来的项目api网页样例：http://typedoc.org/api/global... Typedoc 参考链接:http://typedoc.org/https://github.com/Microsoft/...htt...
typedoc sdk生成脚本文档
12-29
TypeDoc SDK支持文档的自定义化，开发者可以使用一些注释标记来为代码添加描述、类型和标签等信息，用于生成更加详细和准确的文档。此外，开发者还可以自定义生成文档中的导航栏、侧边栏、主题样式等，使生成的文档...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值