Skip to content

Commit

Permalink
docs: 完善 README
Browse files Browse the repository at this point in the history
  • Loading branch information
LeafYeeXYZ committed Aug 27, 2024
1 parent bc9e770 commit 2741e31
Show file tree
Hide file tree
Showing 7 changed files with 89 additions and 9 deletions.
1 change: 0 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ jobs:
- name: Create Release
uses: softprops/action-gh-release@v2
with:
# 不上传 .yml .yaml .blockmap
files: |
dist/*
draft: false
Expand Down
97 changes: 89 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,98 @@
> 🚧 本项目正在开发中
# EasyPaper

**初学者撰写学术论文的最简单方式**

#### 技术说明
## 前言

本软件旨在解决大学新生最头疼的问题之一: 调整论文格式, 帮助初学者更多地把精力放在写作本身上. 它基于十分简单的 Markdown 语法 (哪怕你没听过, 参考下面的示例也能马上上手), 通过图形界面实时预览, 并一键导出指定格式的学术论文

相比于 LaTeX, 本软件更加简单易用, 省去了复杂的配置和学习成本, 但仍然能够满足大部分学术论文的排版需求; 相比于 Word, 本软件完全接管了格式调整的工作, 你只需选择指定的论文模板 (目前仅支持心理学报格式), 专心写作即可

如果你有一定的计算机基础, 也推荐您使用命令行程序 [MarkdownPaper](https://github.com/LeafYeeXYZ/MarkdownPaper), 它的处理逻辑与本软件一致, 但更加灵活, 您可以使用任何您喜欢的编辑器撰写学术论文

## 使用方法

### 1 下载安装

![](./readme/1.png)

![](./readme/2.png)

> 由于作者没钱开通 `Apple Developer` 账号, 所以 `MacOS` 下可能提示软件已损坏, 请参见[这篇文章](https://www.mac2m.com/article/450/)修复; 如果您熟悉 `Node.js`, 也可自行构建, 参见 `package.json` 文件
### 2 新建文档

![](./readme/3.png)

![](./readme/4.png)

### 3 写论文

书写格式如下:

```markdown
# 这是你论文的标题

#author# 小叶子

#school# (北京师范大学心理学部, 北京 100875)

#abstract# 摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容摘要内容

#keywords# 关键词1, 关键词2, 关键词3

## 1 一级标题

### 1.1 二级标题

#### 1.1.1 三级标题

正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文正文

每个自然段之间必须有一个空行

#### 1.1.2 三级标题

这里是图片示例

将图片放在指定的文件夹下, 然后使用 ![](图片文件名) 插入图片

![](123.jpg)

> 图 1 - 这是一张图

## 2 一级标题

这里是表格示例

表格会自动根据内容调整宽度, 但是内容过长时会自动换行

> 表 1 - 这是一张表

| 表头1 | 表头2 |
| :---: | :---: |
| 内容1 | 内容2 |

注意, 不同论文对表格和图片标题在上方或下方有不同的要求, 请根据具体要求调整

##### 参考文献

- 文献1
- 文献2
- 文献3

##### 附录

本软件旨在解决大学新生最头疼的问题之一 - 调整论文格式, 帮助初学者更多地把精力放在写作上; 同时, 本软件基于 Markdown 语法, 也能给用户未来进一步学习 LaTeX 做准备 (但是希望可以部分地淘汰复杂、难配置、中文支持较差的 LaTeX, 仅使用其强大的数学公式生成功能)
附录可以放图片、表格等等等等
```

技术栈为 `React` + `Ant Design` + `Electron(electron-vite)` + `TypeScript` + `TailwindCSS`, 初版支持心理学报格式, 后续将支持北师大毕业论文和 APA 格式
### 4 导出论文

本软件后端实现了我的另一个项目 [MarkdownPaper](https://github.com/LeafYeeXYZ/MarkdownPaper) 的大部分功能 (但由于 Electron 环境奇怪的兼容问题, 没有直接引入它), 也欢迎对计算机有一定了解的朋友使用这个命令行小程序和你喜欢的任意编辑器撰写学术论文
![](./readme/5.png)

软件基本模块包括: 文件打开和自动保存、以指定格式导出、论文格式选择、实时预览; 未来将支持独立的参考文献管理、AI 文章润色和参考文献查询 (基于本地 ollama)、插件系统、插入 LaTeX 公式等功能
## 未来展望

最后, 本人技术和精力都有限, 也欢迎各方大佬一起参与开发!
- [ ] 支持更多的论文格式
- [ ] 支持插入 LaTeX 公式
- [ ] 独立的参考文献管理
- [ ] AI 文章润色和参考文献查询 (基于本地 ollama)
Binary file added readme/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added readme/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2741e31

Please sign in to comment.