Skip to content

arvinxx/npm-template

Repository files navigation

@arvinxu/npm-template

一个开发 npm 项目的模板

Changelog · Report Bug · Request Feature

NPM version NPM downloads install size

Test CI status Deploy CI Coverage

contributors forks stargazers issues

 docs by dumi Build With father

简介

这是一个开发 npm 项目的模板,具有以下特点:

  • 🏗️ 基于 father4 的构建工具:本项目采用了基于 father4 的构建工具,可以更高效地构建项目,提高开发效率;
  • 📖 基于 dumi2 的文档工具:本项目采用了基于 dumi2 的文档工具,可以更方便地编写和管理文档,提高文档的可读性和可维护性;
  • 🚀 基于 vercel 自动化触发文档站构建:本项目使用 vercel 自动化触发文档站构建,可以更快地更新文档站,提高用户的使用体验;
  • 📦 基于 semantic-release 实现 npm 包的自动化发布:本项目使用 semantic-release 实现 npm 包的自动化发布,可以更方便地管理和发布 npm 包,提高开发效率。

快速上手

安装

推荐使用 pnpm 安装

pnpm i @arvinxu/npm-template -S

使用

基于该仓库模板可以快速创建一个 npm 包的工程化脚手架。

迭代记录

2023.06.12 - 完善文档与 README 框架

2022.12.17 - 基于蚂蚁研发技术栈配置完成最新的 npm 研发脚手架

详情:CHANGELOG

🤝 Contributing

📊 Total: 2

📝 License

Copyright © 2020 - present Arvin Xu.
This project is MIT licensed.