> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
> [English](./README.en.md) · [原始项目](https://github.com/batnoter/batnoter) · [上游 README](https://github.com/batnoter/batnoter/blob/HEAD/README.md)
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
创建笔记并将其存储到你的 git 仓库！
https://batnoter.com
## BatNoter
[](https://github.com/batnoter/batnoter/actions?query=branch%3Amain)
[](https://codecov.io/gh/batnoter/batnoter)
[](https://www.codacy.com/gh/batnoter/batnoter/dashboard?utm_source=github.com&utm_medium=referral&utm_content=batnoter/batnoter&utm_campaign=Badge_Grade)
[BatNoter](https://batnoter.com) 是一款 Web 应用，允许用户将笔记存储在其 git 仓库中。这是一个主要使用 react（typescript）、redux-toolkit 和 mui components 构建的前端项目。[BatNoter API](https://github.com/batnoter/batnoter-api) 是该 React 应用所使用的 REST API 的后端实现。
### 功能特性
- 使用 GitHub 登录。
- 通过简洁美观的用户界面，轻松创建、编辑、删除、整理和浏览笔记。
- 支持 Markdown 格式，用户可在笔记中添加超链接、表格、标题、代码块、引用块等。
- 编辑器支持 Markdown 预览。
- 可通过「复制到剪贴板」按钮快速复制代码区域中的代码。
- 可将笔记直接存放在根目录，或使用文件夹进行组织（支持嵌套）。
- 一键浏览指定目录下的全部笔记。
- 所有笔记均存储在用户的 GitHub 仓库中。
- 笔记会缓存以避免额外的 API 调用。
- URL 可收藏为书签。
- 支持深色/浅色模式。
### 本地开发环境配置
#### 前置要求
* Node.js 版本 `18` 及以上
#### 启动服务
```shell
npm install
npm start
```
这将以开发模式启动 React 应用。在浏览器中打开 [http://localhost:3000](http://localhost:3000) 即可查看。
#### 运行测试
```shell
npm test
```
这将执行全部测试，并输出代码覆盖率百分比。
### 贡献指南
> 每一份贡献都弥足珍贵
在参与贡献前，请阅读[贡献指南](CONTRIBUTING.md)。
### 贡献者
感谢以下优秀贡献者 🎉
[](https://github.com/batnoter/batnoter/graphs/contributors)