# flatnotes-zh-cn
**Repository Path**: firfe/flatnotes-zh-cn
## Basic Information
- **Project Name**: flatnotes-zh-cn
- **Description**: flatnotes Docker镜像汉化
原项目 https://github.com/Dullage/flatnotes
我的
GutHub https://github.com/Firfr/flatnotes-zh-cn
Gitee https://gitee.com/firfe/flatnotes-zh-cn
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-16
- **Last Updated**: 2025-09-16
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
A self-hosted, database-less note-taking web app that utilises a flat folder of markdown files for storage.
一个自托管、无数据库的笔记网络应用程序，利用平面文件夹中的 Markdown 文件进行存储。
Log into the [demo site](https://demo.flatnotes.io) and take a look around. *Note: This site resets every 15 minutes.*
登录演示站点并浏览。注意：此站点每 15 分钟重置一次。
## 汉化&修改
当前汉化版本：5.5.3
首先感谢原作者的开源。[原项目地址](https://github.com/dullage/flatnotes)
中文搜索，参考的另一个汉化项目 [https://github.com/jettzhan/flatnotes-zh](https://github.com/jettzhan/flatnotes-zh)
具体汉化了那些内容，请参考[翻译说明](./翻译说明.md)。
只做了汉化和简单修改，有问题，请到原作者仓库处反馈。
欢迎关注我B站账号 [秦曱凧](https://space.bilibili.com/17547201)
有需要帮忙部署这个项目的朋友,一杯奶茶,即可程远程帮你部署，需要可联系。
微信号 `E-0_0-`
闲鱼搜索用户 `明月人间`
或者邮箱 `firfe163@163.com`
如果这个项目有帮到你。欢迎start。
有其他的项目的汉化需求，欢迎提issue。或其他方式联系通知。
### 镜像
从阿里云或华为云镜像仓库拉取镜像，注意填写镜像标签，镜像仓库中没有`latest`标签
容器内部端口 8080 可通过设置环境变量`FLATNOTES_PORT`的值来指定监听端口
```bash
swr.cn-north-4.myhuaweicloud.com/firfe/flatnotes_zh-cn:5.5.3
```
把下面示例中的中文改成实际的值。
### docker run 命令部署
```bash
docker run -d \
--name flatnotes_zh-cn \
--network bridge \
--restart always \
--log-opt max-size=1m \
--log-opt max-file=1 \
-p 端口:8080 \
-e FLATNOTES_SECRET_KEY="aLongRandomSeriesOfCharacters" \
-e FLATNOTES_AUTH_TYPE=password \
-e FLATNOTES_USERNAME="用户名" \
-e FLATNOTES_PASSWORD="密码" \
-v 数据目录:/data \
swr.cn-north-4.myhuaweicloud.com/firfe/flatnotes_zh-cn:5.5.3
```
### compose 文件部署 👍推荐
```yaml
#version: '3'
services:
flatnotes_zh-cn:
container_name: flatnotes_zh-cn
image: swr.cn-north-4.myhuaweicloud.com/firfe/flatnotes_zh-cn:5.5.3
network_mode: bridge
restart: always
logging:
options:
max-size: 1m
max-file: '1'
environment:
TZ: Asia/Shanghai
TIME_ZONE: Asia/Shanghai
FLATNOTES_SECRET_KEY: "aLongRandomSeriesOfCharacters"
FLATNOTES_AUTH_TYPE: password
FLATNOTES_USERNAME: "用户名"
FLATNOTES_PASSWORD: "密码"
ports:
- 端口:8080
volumes:
- 数据目录:/data
```
### 修改说明
这里对除了汉化之外的代码修改的说明。
增加修改部分具体见 [修改说明](./修改说明.md)。
`./README.md` 文件翻译，增加 `## 汉化&修改`
增加目录 `./图片`
新增文件 `./.dockerignore`、`./Dockerfile`、`./翻译说明.md`、`./修改说明.md`、`./本地调试命令记录.md`、`./编辑器汉化.sh`、`./sources.list`
### 效果截图
|  |  |  |
|-|-|-|
## Contents 目录
* [设计原则](#design-principle-设计原则)
* [特性](#features-特性)
* [入门指南](#getting-started-入门指南)
* [托管](#hosted-托管)
* [自托管](#self-hosted-自托管)
* [路线图](#roadmap-路线图)
* [贡献](#contributing-贡献)
* [赞助](#sponsorship-赞助)
* [感谢](#thanks-感谢)
## Design Principle 设计原则
flatnotes is designed to be a distraction-free note-taking app that puts your note content first. This means:
flatnotes 被设计为一款免打扰的笔记应用，将您的笔记内容放在首位。这意味着：
* A clean and simple user interface.
干净简洁的用户界面。
* No folders, notebooks or anything like that. Just all of your notes, backed by powerful search and tagging functionality.
没有文件夹、笔记本或类似的东西。只需所有笔记，并由强大的搜索和标签功能支持。
* Quick access to a full-text search from anywhere in the app (keyboard shortcut "/").
从应用程序的任何地方快速访问全文搜索（键盘快捷键“/”）。
Another key design principle is not to take your notes hostage. Your notes are just markdown files. There's no database, proprietary formatting, complicated folder structures or anything like that. You're free at any point to just move the files elsewhere and use another app.
另一个关键的设计原则是不把您的笔记当作人质。您的笔记只是 Markdown 文件。没有任何数据库、专有格式、复杂的文件夹结构等。您可以随时自由地将这些文件移动到其他地方并使用另一个应用程序。
Equally, the only thing flatnotes caches is the search index and that's incrementally synced on every search (and when flatnotes first starts). This means that you're free to add, edit & delete the markdown files outside of flatnotes even whilst flatnotes is running.
同样，flatnotes 唯一缓存的是搜索索引，并且在每次搜索时（以及 flatnotes 首次启动时）都会增量同步。这意味着即使在 flatnotes 运行时，您也可以自由地添加、编辑和删除外部的 Markdown 文件。
## Features 特性
* Mobile responsive web interface.
移动响应式网页界面。
* Raw/WYSIWYG markdown editor modes.
所见即所得 Markdown 编辑器模式。
* Advanced search functionality.
高级搜索功能。
* Note "tagging" functionality.
笔记“标记”功能。
* Customisable home page.
可自定义的主页。
* Wikilink support to easily link to other notes (`[[My Other Note]]`).
Wiki 链接支持，便于链接到其他笔记（[[我的另一篇笔记]]）。
* Light/dark themes.
浅色/深色主题。
* Multiple authentication options (none, read-only, username/password, 2FA).
多种身份验证选项（无、只读、用户名/密码、2FA）。
* Restful API.
See [the wiki](https://github.com/dullage/flatnotes/wiki) for more details.
更多详情请参阅 wiki。
## Getting Started 入门指南
### Hosted 托管
A quick and easy way to get started with flatnotes is to host it on PikaPods. Just click the button below and follow the instructions.
开始使用 flatnotes 的一个快捷方式是在 PikaPods 上托管它。只需点击下面的按钮并按照说明操作即可。
[](https://www.pikapods.com/pods?run=flatnotes)
### Self Hosted 自托管
If you'd prefer to host flatnotes yourself then the recommendation is to use Docker.
如果您更愿意自己托管 flatnotes，则建议使用 Docker。
### Example Docker Run Command
Docker 运行命令示例
```shell
docker run -d \
-e "PUID=1000" \
-e "PGID=1000" \
-e "FLATNOTES_AUTH_TYPE=password" \
-e "FLATNOTES_USERNAME=user" \
-e 'FLATNOTES_PASSWORD=changeMe!' \
-e "FLATNOTES_SECRET_KEY=aLongRandomSeriesOfCharacters" \
-v "$(pwd)/data:/data" \
-p "8080:8080" \
dullage/flatnotes:latest
```
### Example Docker Compose
Docker Compose 示例
```yaml
version: "3"
services:
flatnotes:
container_name: flatnotes
image: dullage/flatnotes:latest
environment:
PUID: 1000
PGID: 1000
FLATNOTES_AUTH_TYPE: "password"
FLATNOTES_USERNAME: "user"
FLATNOTES_PASSWORD: "changeMe!"
FLATNOTES_SECRET_KEY: "aLongRandomSeriesOfCharacters"
volumes:
- "./data:/data"
# Optional. Allows you to save the search index in a different location:
# - "./index:/data/.flatnotes"
ports:
- "8080:8080"
restart: unless-stopped
```
See the [Environment Variables](https://github.com/dullage/flatnotes/wiki/Environment-Variables) article in the wiki for a full list of configuration options.
有关完整的配置选项列表，请参阅 wiki 中的环境变量文章。
## Roadmap 路线图
I want to keep flatnotes as simple and distraction-free as possible which means limiting new features. This said, I welcome feedback and suggestions.
我希望保持 flatnotes 尽可能简单和免打扰，这意味着限制新功能。尽管如此，我还是欢迎反馈和建议。
## Contributing 贡献
If you're interested in contributing to flatnotes, then please read the [CONTRIBUTING.md](CONTRIBUTING.md) file.
如果您有兴趣为 flatnotes 做出贡献，请阅读 CONTRIBUTING.md 文件。
## Sponsorship 赞助
If you find this project useful, please consider buying me a beer. It would genuinely make my day.
如果您觉得这个项目有用，请考虑请我喝一杯啤酒。这真的会让我的一天变得美好。
[](https://github.com/sponsors/Dullage)
## Thanks 感谢
A special thanks to 2 fantastic open-source projects that make flatnotes possible.
特别感谢两个使 flatnotes 成为可能的出色开源项目。
* [Whoosh](https://whoosh.readthedocs.io/en/latest/intro.html) - A fast, pure Python search engine library.
Whoosh - 一个快速、纯 Python 的搜索引擎库。
* [TOAST UI Editor](https://ui.toast.com/tui-editor) - A GFM Markdown and WYSIWYG editor for the browser.
TOAST UI Editor - 用于浏览器的 GFM Markdown 和 WYSIWYG 编辑器。