用户使用手册

下载与安装

初始化

#1. clone project
git clone https://github.com/sustech-cs304/team-project-25spring-18.git

#2. Install dependencies
# Install for python
cd backend
pip install -r requirements.txt

#Install for vscode 
npm install -g pnpm 
cd frontend/main
pnpm install

#setup project
#Use vscode debug or press F5
run 'run extension'

主要功能

1. 笔记

提供便捷的笔记记录功能，支持 Markdown 格式，方便整理学习内容。

• 向Markdown文件添加多样化的笔记

新建语法

• 书签：=={text}==
• 跳转链接：++{text}++
• 签名：@@{text}@@

自动展示markdownPreview

默认情况下点击markdown文件会自动展示preview，如果用户（windows）希望关闭则点击ctrl + ,进入设置页面，搜索**Auto Markdown Preview** ，勾选或取消勾选 Enable automatic preview...

• 执行课件中的代码

2. 文件同步：与协作者共享文件进度

指定同步文件夹，实现本地与远程文件的同步，支持多人协作编辑，提高写作效率。

[profile]
workdir = ..\fileSync
exclude = ..\fileSync\exclude

3. 聊天室：与协作者实时沟通

内置实时聊天室，方便团队成员之间的沟通与交流。

• 在边栏中使用聊天室

  

• 创建一个现有的聊天室，或加入一个现有的聊天室

  

• 实时发送和接收

  

4. 进度跟踪助手：管理任务和进度

帮助用户跟踪学习进度，设置学习目标，提升自我管理能力

在边栏启动进度跟踪助手

5. AI助手：提供多种类型帮助

集成智能 AI 助手，提供代码检查、随堂测验等功能，辅助学习与开发。

在边栏启动AI助手

• 聊天(Chat)：点击按钮，启动聊天功能

  

• 思维导图(Mind Map)点击按钮，生成思维导图

  

• 课程总结(Lecture Summary)点击按钮，生成课程总结

• 代码审查(Code Check)：代码执行后，选择发送AI助手

  

• 小测验(Quiz)：点击按钮，启动测验功能

  

常见问题

--