trueSightDoc

vite 构建的第三方库

• 在线制作产品手册、帮助中心、FAQ、Guide、知识库、产品介绍、开发文档、在线手册baklib

Install and use

• Get the project code

git clone http://git.inner.truesightai.com/cc/true-sight-lib.git

• Installation dependencies

cd true-sight-lib
# window
npm install
# mac OS
sudo npm install

• 目录

true-sight-lib
 ├── README.md
 ├── src                            // 项目目录
 │   ├── utils                      // 通用库编写
 │   ├── doc                        // baklib第三方文档实例
 │   ├── enums                      // 项目枚举
 │   ├── packages                   // UI库
 │   └── main.ts
 ├── preview                        // 本地预览插件
 │   ├── main.ts
 │   ├── App.vue
 │   └── env.d.ts
 ├── lib                            // 打包生成的SDK文件
 │   ├── types
 │   ├── [email protected]
 │   ├── [email protected]
 │   ├── [email protected]        // ES Module引入
 │   ├── [email protected]       // AMD、Node、window 或 global
 │   └── src
 ├── package.json
 ├── tsconfig.json
 ├── types
 │   ├── axios.d.ts
 │   ├── global.d.ts
 │   └── config.d.ts
 ├── vite.config.ts
 └── prettier.config.js

• build

npm run build

本地运行

• 本地调试

# 在true-sight-lib目录下执行npm link，将true-lib设置为全局npm库
npm link

# 在项目里面引入
npm link true-lib

• npm

# window
cnpm install true-lib
# mac OS
sudo cnpm install true-lib

CDN

<script src="https://unpkg.com/[email protected]/lib/[email protected]"></script>;
const { BakLibApi } = window.trueSdk;

ES6

import { BakLibApi } from 'true-lib';
// ...其它sdk