Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leafyeexyz/easypaper
初学者撰写学术论文的最简单方式, 支持 Windows + MacOS
https://github.com/leafyeexyz/easypaper
academic academy ant-design antd article beijing-normal-university bnu electron electron-vite markdown paper psychology react tailwind tailwindcss typescript
Last synced: 2 months ago
JSON representation
初学者撰写学术论文的最简单方式, 支持 Windows + MacOS
- Host: GitHub
- URL: https://github.com/leafyeexyz/easypaper
- Owner: LeafYeeXYZ
- License: gpl-3.0
- Created: 2024-08-22T11:44:55.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-29T10:46:50.000Z (3 months ago)
- Last Synced: 2024-10-10T11:44:26.887Z (2 months ago)
- Topics: academic, academy, ant-design, antd, article, beijing-normal-university, bnu, electron, electron-vite, markdown, paper, psychology, react, tailwind, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 5.87 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# EasyPaper
**初学者撰写学术论文的最简单方式**
## 1 前言
本软件旨在解决大学新生最头疼的问题之一: 调整论文格式, 帮助初学者更多地把精力放在写作本身上. 它基于十分简单的 Markdown 语法 (哪怕你没听过, 参考下面的示例也能马上上手), 通过图形界面实时预览, 并一键导出指定格式的学术论文
相比于 LaTeX, 本软件更加简单易用, 省去了复杂的配置和学习成本, 但仍然能够满足大部分学术论文的排版需求; 相比于 Word, 本软件完全接管了格式调整的工作, 你只需选择指定的论文模板 (目前仅支持心理学报格式), 专心写作即可
如果你有一定的计算机基础, 也推荐您使用命令行程序 [MarkdownPaper](https://github.com/LeafYeeXYZ/MarkdownPaper), 它的处理逻辑与本软件基本一致, 但更加灵活和强大 (如支持导出 DOCX 文件), 您还可以使用任何您喜欢的编辑器撰写学术论文
## 2 使用方法
### 2.1 下载安装
**请先卸载旧版本, 再安装最新版本**
> 由于小叶子没钱开通 `Apple Developer` 账号, 所以 `MacOS` 下可能提示软件已损坏, 请参见[这篇文章](https://www.mac2m.com/article/450/)修复; 如果您熟悉 `Node.js` 或其他编程语言, 也可自行编译, 参见 [3.3 本地开发](#33-本地开发)
### 2.2 新建文档
### 2.3 写论文
书写格式如下
```markdown
# 这是你论文的标题
#author# 小叶子
#school# (北京师范大学心理学部, 北京 100875)
#abstract# 摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容
#keywords# 关键词1, 关键词2, 关键词3
## 1 一级标题
### 1.1 二级标题
#### 1.1.1 三级标题
#### 1.1.2 正文写法
正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文
每个自然段之间必须有一个空行
#### 1.1.3 数学公式写法
这是段内数学公式的写法: $c = \pm\sqrt{a^2 + b^2}$
这是单独数学公式的写法:
$$
c = \pm\sqrt{a^2 + b^2}
$$
#### 1.1.4 表格写法
表格会自动根据内容调整宽度, 但是内容过长时会自动换行
> 表 1 - 这是表格的标题
| 表头1 | 表头2 |
| :---: | :---: |
| 内容1 | 内容2 |
注意, 不同论文对表格和图片标题在上方或下方有不同的要求, 请根据具体要求调整
#### 1.1.5 图片写法
将图片放在和 `.md` 同一个文件夹下, 然后使用  插入图片, 例如:
> 图 1 - 这是图片的标题
## 2 一级标题
### 2.1 二级标题
#### 2.1.1 三级标题
...
##### 参考文献
- 文献1
- 文献2
- 文献3
##### 附录
附录可以放图片、表格等等等等
```
> 数学公式语法详见 [https://katex.org](https://katex.org) 和[这篇中文文章](https://kissingfire123.github.io/2022/02/18_数学公式katex常用语法总结)
### 2.4 导出论文
## 3 开发说明
### 3.1 主题开发
如果您想**参与开发新论文模板**, 请在 `/lib/themes.ts` 中定义并导出类型为 `MarkdownPaperTheme` 的对象, 并在 `/lib/utils.ts` 导入并将其添加到 `THEMES` 数组中
### 3.2 未来计划
- [ ] 支持更多的论文格式
- [ ] 黑暗模式
- [ ] 给软件弄一个漂亮的图标
### 3.3 本地开发
本软件的技术栈为 `Electron(Electron Vite)` + `React` + `TailwindCSS` + `Ant Design`; 在开始前, 请自行安装 `Node.js` (推荐安装最新的 `LTS` 版本), 推荐使用 [`Bun`](https://bun.sh) 作为包管理工具
```bash
# 1 克隆项目
git clone https://github.com/LeafYeeXYZ/EasyPaper.git
# 2 进入项目目录
cd ./EasyPaper
# 3 安装依赖
bun install # 或 npm install
# 4 开发和构建
# 4.1 开发
bun dev # 或 npm run dev
# 4.2 构建 Windows 和 macOS 应用
bun build:both # 或 npm run build:both
```
### 3.4 文件结构
- `lib`: 存放论文模板(主题)相关内容, 被 `main`、`preload`、`renderer` 共用 (注意兼容性)
- `src/main`: 主进程
- `src/preload`: 预加载脚本
- `src/renderer`: 渲染进程
- `readme`: 存放 `README.md` 中的图片
- `resources`: 存放软件图标
## 4 致谢
感谢[蟹黄]()为本软件绘制了可爱的图标!