使用方法.md 1.93 KB

使用方法

环境准备

  • Node.js ≥ 20
  • 包管理器:npm
cd knowledgebase-site
npm install

本地开发

方式一:一键启动

npm run dev

同时启动站点(端口 3000)和 CMS 代理(端口 8081)。

方式二:分开启动

# 终端 1 - 站点
npm run serve -- --port 3000

# 终端 2 - CMS 代理
npm run cms

访问地址

页面 URL
知识库首页 http://localhost:3000
CMS 后台 http://localhost:3000/admin

CMS 后台使用

登录

  1. 打开 http://localhost:3000/admin
  2. 点击 Login 按钮
  3. 连接本地 decap-server(端口 8081)
  4. 进入编辑界面

编辑文档

  1. 左侧选择分类(如 "01 - 产品总览")
  2. 点击要编辑的文章标题
  3. 修改标题、路径或正文内容
  4. 修改自动保存

新建文档

  1. 左侧选择目标分类
  2. 点击右上角 + 按钮
  3. 填写标题和正文
  4. 保存

删除文档

  • 打开文章 → 点击右上角 Delete entry

更新前台页面

CMS 编辑后,前台页面是静态构建,需手动重建:

npm run build
npm run serve -- --port 3000

或生产环境下提交代码后 CI/CD 自动构建。

添加新文档分类

  1. docs/ 下新建目录(如 08-新分类
  2. 创建 _category_.json 配置侧边栏: json { "label": "08 - 新分类", "position": 8 }
  3. static/config.yml 添加对应 collection
  4. src/pages/index.jscategories 数组中添加首页卡片
  5. 执行 npm run build

常用命令

命令 说明
npm run build 构建生产版本(含搜索索引)
npm run serve 启动本地预览服务器
npm run start 启动开发服务器(无搜索索引)
npm run cms 启动 CMS 文件代理
npm run dev 同时启动站点 + CMS
npm run clear 清除缓存(构建出错时使用)