# template-docs

**Repository Path**: Cano1997/template-docs

## Basic Information

- **Project Name**: template-docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2025-05-22
- **Last Updated**: 2026-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# template-docs

## 快速开始

### 修改配置

- `ibiz-generate-dts.config.ts`配置文件:
    `..` 替换成 `/home/zpc/workspace/template`
- `ibiz-mob-generate-doc.config.ts`配置文件:
    `..` 替换成 `/home/zpc/workspace/template` 
    `./toolkits` 替换成 `/home/zpc/workspace/toolkits`
- `ibiz-web-generate-doc.config.ts`配置文件:
    `..` 替换成 `/home/zpc/workspace/template`
    `./toolkits` 替换成 `/home/zpc/workspace/toolkits`
- `package.json`文件中scripts脚本中发布模型配置:
    `..` 替换成 `/home/zpc/workspace/project`

其中 `/home/zpc/workspace/template` 替换成底包本地路径， `/home/zpc/workspace/project` 替换成项目本地路径，`/home/zpc/workspace/toolkits`替换成语义化资源本地地址


### 命令介绍

1. `npm run config:build` 修改web端/移动端配置文档
2. `npm run publish:api` 发布接口文档
3. `npm run publish:web:model` 发布web端模型
4. `npm run publish:web:docs` 发布web端文档
5. `npm run publish:mob:model` 发布移动端模型
6. `npm run publish:mob:docs` 发布移动端文档
7. `npm run publish:all` 批量发布
8. `npm run docs:dev` 本地启动
9. `npm run docs:build` 打包构建

### 语义化/Design Token 配置

1. dirPathConfig配置新增semanticBasePath（语义化结构基础路径）属性
2. 文档项新增semanticFilePath（语义化配置文件路径）、tokenFilePath（Design Token配置文件路径）、semantic（语义化元数据配置）
3. 语义化元数据配置项，先补充caption、viewId属性，再执行pnpm config:build 完善uuid的填充