README.zh_CN.md

Accelerate Your Research

English | 中文

研究小助手

研究小助手是一款开源的文献管理工具。它有着内置的 PDF 阅读器，所见即所得的 Markdown 编辑器以及 Excalidraw 画板。你可以很好地用它来管理自己的电子书，文献以及笔记。

文献管理

你可以在书库页面管理你的文献。

• 收藏、分类、标签、搜索，基本功能一应俱全
• 能根据 DOI 等信息一键获取该文献的详细信息以及相关文献

文献阅读

自带的 PDF 阅读器能够让你浏览你的文献。

• 可调节页面布局、明暗模式、全屏模式等
• 注释支持 markdown 格式,以及 latex 语法
• 内部链接可在悬浮窗预览，轻松查看公式与图表

笔记系统

得益于多窗口布局，阅读文献的同时记笔记是如此轻松

• 笔记分为所见即所得的 markdown 笔记以及自由画板的 excalidraw 笔记两种类型
• markdown 笔记能轻松引用别的文献或笔记
• markdown 笔记支持数学公式、代码块、思维导图等的渲染

为研究小助手作贡献

研究小助手用QUASAR作为框架。这款软件采用了Vue.js3加Electron的组合。

安装依赖

yarn # 推荐用yarn
# 或者
npm install

开始开发吧

yarn dev # electron 开发模式

编译

yarn build # 编译发行版 
# 或者 
yarn debug # 编译带着debugger的测试版  

测试

yarn test:unit:ci # 后端单元测试 
yarn test:component:ci # 前端Vue Component测试

致谢

没有以下的开源项目就没有这款软件

• Quasar
• Electron
• Vue.js
• citation-js
• cytoscape
• golden-layout
• pdf.js
• vditor
• Pouchdb
• Excalidraw

许可证

本项目采用了 AGPL 许可证。