跳到主要内容

使用指南

本文档介绍如何使用和维护 Aurisper 知识库。

一、访问知识库​

访问地址​

访问权限​

知识库受 Cloudflare Access 保护，访问时需要：

  1. 输入公司邮箱（@aurisper.com）
  2. 查收验证码邮件
  3. 输入验证码完成登录
  4. 登录状态保持 24 小时

二、更新文档流程​

方式一：使用 GitHub Desktop（推荐非技术人员）​

首次设置​

  1. 下载安装 GitHub Desktop
  2. 登录你的 GitHub 账号
  3. Clone 仓库：File → Clone Repository → 选择 aurisper-doc
  4. 选择本地保存路径（如 ~/Documents/aurisper-doc）

日常更新​

  1. 打开 GitHub Desktop，确保在 aurisper-doc 项目
  2. 点击 "Fetch origin" 拉取最新内容
  3. 用编辑器（VS Code / Typora）打开项目文件夹
  4. 在 docs/ 目录下新建或修改 .md 文件
  5. 回到 GitHub Desktop，填写 Summary（如"更新产品手册"）
  6. 点击 "Commit to main"
  7. 点击 "Push origin"
  8. 等待 2-3 分钟，网站自动更新

方式二：使用命令行（技术人员）​

# 进入项目目录
cd ~/aurisper-doc

# 拉取最新
git pull

# 修改文件后提交
git add .
git commit -m "更新: xxx文档"
git push

# 等待 2-3 分钟自动部署

三、文档编写规范​

文件命名​

  • 使用小写英文或拼音
  • 单词间用 - 连接
  • 示例：product-requirement.md、api-design.md

目录结构​

docs/
├── intro.md              # 首页
├── guide/                # 使用指南
│   ├── usage.md
│   └── architecture.md
├── product/              # 产品文档
│   ├── requirements/
│   └── design/
├── tech/                 # 技术文档
│   ├── architecture/
│   └── api/
└── meeting/              # 会议纪要

Markdown 头部​

每个 .md 文件开头需要添加：

---
sidebar_position: 1      # 侧边栏排序（数字越小越靠前）
title: 文档标题           # 可选，默认用一级标题
---

# 文档标题

正文内容...

插入图片​

  1. 将图片放入 static/img/ 目录
  2. 在 Markdown 中引用：
![图片描述](/img/your-image.png)

插入 PDF​

  1. 将 PDF 放入 static/pdf/ 目录
  2. 在 Markdown 中添加链接：
[点击下载 PDF](/pdf/document.pdf)

插入 HTML 页面​

  1. 将 HTML 文件放入 static/html/ 目录
  2. 在 Markdown 中添加链接：
[查看报告](/html/report.html)

四、常见问题​

Q: 修改后网站没更新？​

A: 请检查：

  1. 是否已 Push 到 GitHub（GitHub Desktop 显示 "Push origin"）
  2. 等待 2-3 分钟构建时间
  3. 清除浏览器缓存后刷新

Q: 构建失败怎么办？​

A: 查看 Cloudflare Pages 的构建日志，常见原因：

  • Markdown 语法错误
  • 链接指向不存在的文件
  • 图片路径错误

Q: 如何删除文档？​

A: 直接删除对应的 .md 文件，然后 commit + push。

Q: 如何修改侧边栏顺序？​

A: 修改文件头部的 sidebar_position 数值。

五、联系支持​

如有问题，请联系：