前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >使用 paka.dev 为 npm 包生成文档

使用 paka.dev 为 npm 包生成文档

原创
作者头像
小小杰啊
修改2022-11-30 02:12:40
4940
修改2022-11-30 02:12:40
举报
文章被收录于专栏:Dimples开发记

##  起因

在编写我个人的前端工具库的时候,想要为项目生成一个 API 文档,因为项目使用的是 TypeScript ,自然就想到使用 TypeDOC 为项目来生成一个文档,经过一番学习,发现 TypeDOC 生成的 API 文档随便可以使用各种主题插件,但是还是有点不好看,然后就一直没有做这件事。

## 发现 paka.dev 这个网站

在查看项目的 dependabot 提交的更新时,发现大神 antfu 也有自己的工具函数库

然后我就点进去看,看到 Readme 上有个小小的图标,如下图所示:

标签,点进去一看,就是一个 API 文档,而且非常好看,大概的样子就是下面这样(这里我就替换成我自己的工具库的 API 文档的图片啦)

查看URL就可以知道,这里应该是通过引用 npmjsgithub 共同来生成的,规则大概是这样

代码语言:javascript
复制
https://paka.dev/npm/[发包到npm上的包名]@[版本号]

将上面的 URL 替换成自己的,然后复制到浏览器直接访问即可看到自己的工具库的 API 文档

最后也欢迎大家使用我的工具函数库,其中是我自己在工作、学习当中的一些常用的工具函数的封装,同样也欢迎大家提 PR 或者 ISSUE

Github : @dimples/util

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
相关产品与服务
内容识别
内容识别(Content Recognition,CR)是腾讯云数据万象推出的对图片内容进行识别、理解的服务,集成腾讯云 AI 的多种强大功能,对存储在腾讯云对象存储 COS 的数据提供图片标签、图片修复、二维码识别、语音识别、质量评估等增值服务。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档