gitee-api-doc-view

Gitee OpenAPI forntend project

Usage no npm install needed!

<script type="module">
  import giteeApiDocView from 'https://cdn.skypack.dev/gitee-api-doc-view';
</script>

README

gitee-api-doc-view

npm gitee-release-cli

目录

介绍

码云 OpenAPI 文档视图库。

开发

gitee-api-doc-view 仓库：

# 克隆本仓库
git clone git@gitee.com:gitee-frontend/gitee-api-doc-view.git

# 进入仓库目录
cd gitee-api-doc-view

# 安装依赖
npm install

# 将 gitee-api-doc-view 链接到全局 node_modules 目录里
npm link

# 开始构建资源（development 模式）
npm start

主仓库：

# 将全局 node_modules 目录中的 gitee-api-doc-view 链接链接到当前 node_moudles 目录中
npm link gitee-api-doc-view

# 构建资源（development 模式）
npm run dev:main

发布

先决条件：

  • 已在 npmjs.org 上注册了账号
  • 账号已经加入 gitee 组织，且有权限管理 gitee-api-doc-view 包
  • 已用 npm login 命令登录了这个账号
  • 依赖的 gitee-vendor-dll 包和主仓库中的一致
  • 测试没问题

之后在命令行中运行：

# 创建 beta 预发行版
npm run release-beta

# 发布测试版
npm publish --tag=beta

# 创建正式发行版
npm run release

# 发布正式版
npm publish

主仓库：

# 安装刚刚发布的测试版
npm install gitee-api-doc-view@beta

# 或者安装最新正式版
npm install gitee-api-doc-view@latest

# 构建资源
npm run build

规范

参考主仓库的前端开发规范。