starter-lib-ts
v1.1.0
Published
TypeScript library starter template, provides VitePress documentation, supports building ESM, CJS and IIFE formats.
Downloads
125
Readme
TypeScript 库启动模板
TypeScript 库启动模板，提供 VitePress 在线文档，支持构建 ESM、CJS 和 IIFE 格式。
特性
- 使用 tsup 构建包 - 无需配置即可打包 TypeScript 库。
- 开箱即用的 Vitest 单元测试。
- VitePress 文档 - 零配置部署到 Netlify，并支持其他部署方式。
- 使用 bumpp 进行管理版本，同时零配置发布到 npm。
使用方法
从 GitHub 上 创建一个仓库 基于此模板。
git clone <git 远程地址>安装 npm 依赖。
cd starter-lib-ts # 或者你的项目目录
pnpm i # 如果你没有安装 pnpm，运行：npm install -g pnpm运行 dev 脚本来构建你的文件。
pnpm dev要打开库的在线文档，你可以运行：
pnpm docs:dev要构建库，你可以运行：
pnpm build如果你想发布库，可以运行：
pnpm release清理模板
如果你更喜欢手动操作并保持更清晰的 git 历史记录：
npx degit starter-collective/starter-lib-tsbstarter-lib-tsr-lib-ts
cd starter-lib-ts
pnpm i # 如果你没有安装 pnpm，运行：npm install -g pnpm使用此模板时，请按照以下检查列表正确更新信息：
- [ ] 更改
LICENSE中的作者姓名。 - [ ] 更改
package.json中的包名。 - [ ] 更改
docs/*中的网站信息。
许可证
MIT 许可证 © 2024-PRESENT Kieran Wang