4.4 KiB
4.4 KiB
项目全局
项目简介
License Manager Docs 是 License Manager(企业级软件授权管理系统)的官方文档站点,基于 VitePress 构建。
License Manager 是一套完整的软件商业化生态解决方案,提供从授权生成到售后服务的全生命周期管理,支持 SaaS 订阅、永久授权、试用转化等多种商业模式。
目录结构
license-manager-docs/
├── .github/
│ └── workflows/
│ └── deploy.yml # CI/CD 部署配置
├── docs/ # 文档源文件(主要编写区域)
│ ├── index.md # 首页(VitePress home 配置)
│ ├── guide/ # 中文使用指南
│ │ ├── index.md
│ │ ├── getting-started.md # 快速入门
│ │ ├── api.md # API 文档
│ │ ├── sdk.md # SDK 使用
│ │ ├── business_value.md # 商业价值
│ │ ├── community_strategy.md
│ │ ├── client-simulator.md # 客户端模拟器
│ │ ├── license-token-structure.md
│ │ ├── operating_guide.md # 运营指南
│ │ └── cases/ # 客户案例
│ │ └── machine-vision-licensing.md # 机器视觉检测软件授权方案
│ ├── en/ # 英文使用指南(与 guide 一一对应)
│ │ ├── index.md
│ │ ├── guide/ # 英文文档子目录
│ │ │ ├── api.md
│ │ │ ├── business_value.md
│ │ │ ├── client-simulator.md
│ │ │ ├── community_strategy.md
│ │ │ ├── getting-started.md
│ │ │ ├── index.md
│ │ │ ├── license-token-structure.md
│ │ │ ├── operating_guide.md
│ │ │ ├── sdk.md
│ │ │ └── cases/ # 英文客户案例
│ │ │ └── machine-vision-licensing.md
│ │ └── index.md
│ ├── public/ # 静态资源(无需构建处理)
│ │ ├── images/
│ │ │ ├── logo.png
│ │ │ ├── LMClientSimulator-win64.png
│ │ │ └── qrcode_1755081220153.jpg
│ │ ├── custom.css
│ │ ├── robots.txt
│ │ ├── sitemap.xml
│ │ └── site.webmanifest
│ └── .vitepress/
│ ├── config.mjs # VitePress 站点配置(导航栏、侧边栏、主题等)
│ ├── cache/ # 构建缓存(自动生成,可忽略)
│ └── dist/ # 静态站点产物(deploy.yml 会部署此目录)
├── docs-blog/ # 博客文章/草稿(文档创作过程的笔记)
│ ├── 提示词/
│ │ └── 项目全局.md # 本文件
│ ├── Python-SDK发布.md
│ ├── CSDN-软件版权保护原理.md
│ ├── 产品介绍.md
│ ├── swagger.json # API 原始定义
│ └── 知识-软件和硬件指纹的区别和授权原理.md
├── node_modules/ # npm 依赖(自动生成,无需编辑)
├── .gitignore
├── BAIDU_SEO_README.md # 百度 SEO 说明
├── CNAME # 自定义域名配置
├── package.json # npm 脚本与依赖声明
└── README.md # 项目说明
技术栈
| 类别 | 技术 |
|---|---|
| 文档框架 | VitePress v1.0.0 |
| 图表渲染 | Mermaid v11 |
| 部署 | GitHub Actions (.github/workflows/deploy.yml) |
| 搜索 | Algolia DocSearch |
常用命令
| 命令 | 说明 |
|---|---|
npm install |
安装依赖 |
npm run docs:dev |
本地开发预览(默认 http://localhost:5173) |
npm run docs:build |
构建静态站点,产物输出到 docs/.vitepress/dist/ |
npm run docs:preview |
预览构建产物 |
快速导航
- 快速入门 — 部署与接入指南
- API 文档 — 接口说明
- SDK 文档 — 多语言 SDK 接入
- License 令牌结构 — 授权加密原理