docs: make Chinese README the default
Backend Tests / Static Checks (push) Has been cancelled
Backend Tests / Tests (internal) (push) Has been cancelled
Backend Tests / Tests (other) (push) Has been cancelled
Backend Tests / Tests (server) (push) Has been cancelled
Backend Tests / Tests (store) (push) Has been cancelled
Release Please / release-please (push) Has been cancelled
Frontend Tests / Lint (push) Has been cancelled
Frontend Tests / Build (push) Has been cancelled
Proto Linter / Lint Protos (push) Has been cancelled
Build Canary Image / build-frontend (push) Has been cancelled
Build Canary Image / merge (push) Has been cancelled
Build Canary Image / build-push (linux/amd64) (push) Has been cancelled
Build Canary Image / build-push (linux/arm64) (push) Has been cancelled
Backend Tests / Static Checks (push) Has been cancelled
Backend Tests / Tests (internal) (push) Has been cancelled
Backend Tests / Tests (other) (push) Has been cancelled
Backend Tests / Tests (server) (push) Has been cancelled
Backend Tests / Tests (store) (push) Has been cancelled
Release Please / release-please (push) Has been cancelled
Frontend Tests / Lint (push) Has been cancelled
Frontend Tests / Build (push) Has been cancelled
Proto Linter / Lint Protos (push) Has been cancelled
Build Canary Image / build-frontend (push) Has been cancelled
Build Canary Image / merge (push) Has been cancelled
Build Canary Image / build-push (linux/amd64) (push) Has been cancelled
Build Canary Image / build-push (linux/arm64) (push) Has been cancelled
This commit is contained in:
@@ -1,29 +1,35 @@
|
||||
> ✨ Featured Sponsor: [CodeRabbit](https://coderabbit.link/usememos) — Cut code review time & bugs in half, instantly.
|
||||
<!-- WEHUB_ZH_README -->
|
||||
> [!NOTE]
|
||||
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
|
||||
> [English](./README.en.md) · [原始项目](https://github.com/usememos/memos) · [上游 README](https://github.com/usememos/memos/blob/HEAD/README.md)
|
||||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||||
|
||||
> ✨ 特色赞助商:[CodeRabbit](https://coderabbit.link/usememos)) —— 立即将代码审查时间和 Bug 减少一半。
|
||||
|
||||
# Memos
|
||||
|
||||
<img align="right" height="96px" src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/logo-rounded.png" alt="Memos" />
|
||||
|
||||
Open-source, self-hosted note-taking tool built for quick capture. Markdown-native, lightweight, and fully yours.
|
||||
开源、自托管的笔记工具,专为快速记录而生。原生 Markdown、轻量级、完全归你掌控。
|
||||
|
||||
[](https://usememos.com)
|
||||
[](https://demo.usememos.com/)
|
||||
[](https://usememos.com/docs)
|
||||
[](https://usememos.com)
|
||||
[](https://demo.usememos.com/)
|
||||
[](https://usememos.com/docs)
|
||||
[](https://discord.gg/tfPJa4UmAv)
|
||||
[](https://hub.docker.com/r/neosmemo/memos)
|
||||
[](https://hub.docker.com/r/neosmemo/memos)
|
||||
|
||||
<img src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png" alt="Memos Demo Screenshot" height="512" />
|
||||
<img src="https://raw.githubusercontent.com/usememos/.github/refs/heads/main/assets/demo.png" alt="Memos 演示截图" height="512" />
|
||||
|
||||
## Features
|
||||
## 功能特性
|
||||
|
||||
- **Instant Capture** — Timeline-first UI. Open, write, done — no folders to navigate.
|
||||
- **Total Data Ownership** — Self-hosted on your infrastructure. Notes stored in Markdown, always portable. Zero telemetry.
|
||||
- **Radical Simplicity** — Single Go binary, ~20MB Docker image. One command to deploy with SQLite, MySQL, or PostgreSQL.
|
||||
- **Open & Extensible** — MIT-licensed with full REST and gRPC APIs for integration.
|
||||
- **即时记录** — 时间线优先的界面。打开、书写、完成——无需管理文件夹。
|
||||
- **数据完全归你** — 部署在你自己的基础设施上。笔记以 Markdown 格式存储,始终可迁移。零遥测。
|
||||
- **极致简洁** — 单个 Go 二进制文件,约 20MB 的 Docker 镜像。一条命令即可部署,支持 SQLite、MySQL 或 PostgreSQL。
|
||||
- **开放可扩展** — 采用 MIT 许可,提供完整的 REST 和 gRPC API 用于集成。
|
||||
|
||||
## Quick Start
|
||||
## 快速开始
|
||||
|
||||
### Docker (Recommended)
|
||||
### Docker(推荐)
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
@@ -33,56 +39,57 @@ docker run -d \
|
||||
neosmemo/memos:stable
|
||||
```
|
||||
|
||||
Open `http://localhost:5230` and start writing!
|
||||
打开 `http://localhost:5230` 开始写作!
|
||||
|
||||
### Native Binary
|
||||
### 原生二进制
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/usememos/memos/main/scripts/install.sh | sh
|
||||
```
|
||||
|
||||
### Try the Live Demo
|
||||
### 试试在线演示
|
||||
|
||||
Don't want to install yet? Try our [live demo](https://demo.usememos.com/) first!
|
||||
还不想安装?先试试我们的[在线演示](https://demo.usememos.com/))吧!
|
||||
|
||||
### Other Installation Methods
|
||||
### 其他安装方式
|
||||
|
||||
- **Docker Compose** - Recommended for production deployments
|
||||
- **Pre-built Binaries** - Available for Linux, macOS, and Windows
|
||||
- **Kubernetes** - Helm charts and manifests available
|
||||
- **Build from Source** - For development and customization
|
||||
- **Docker Compose** — 推荐用于生产部署
|
||||
- **预编译二进制** — 适用于 Linux、macOS 和 Windows
|
||||
- **Kubernetes** — 提供 Helm Charts 和清单文件
|
||||
- **从源码构建** — 用于开发和自定义
|
||||
|
||||
See our [installation guide](https://usememos.com/docs/deploy) for detailed instructions.
|
||||
详细说明请参阅我们的[安装指南](https://usememos.com/docs/deploy))。
|
||||
|
||||
## Contributing
|
||||
## 贡献指南
|
||||
|
||||
Contributions are welcome — bug reports, feature suggestions, pull requests, documentation, and translations.
|
||||
欢迎各种形式的贡献——Bug 报告、功能建议、拉取请求、文档完善和翻译。
|
||||
|
||||
- [Report bugs](https://github.com/usememos/memos/issues/new?template=bug_report.md)
|
||||
- [Suggest features](https://github.com/usememos/memos/issues/new?template=feature_request.md)
|
||||
- [Submit pull requests](https://github.com/usememos/memos/pulls)
|
||||
- [Improve documentation](https://github.com/usememos/dotcom)
|
||||
- [Help with translations](https://github.com/usememos/memos/tree/main/web/src/locales)
|
||||
- [报告 Bug](https://github.com/usememos/memos/issues/new?template=bug_report.md)
|
||||
- [建议功能](https://github.com/usememos/memos/issues/new?template=feature_request.md)
|
||||
- [提交拉取请求](https://github.com/usememos/memos/pulls)
|
||||
- [改进文档](https://github.com/usememos/dotcom)
|
||||
- [协助翻译](https://github.com/usememos/memos/tree/main/web/src/locales)
|
||||
|
||||
## Sponsors
|
||||
* [**CodeRabbit** - Cut code review time & bugs in half, instantly](https://coderabbit.link/usememos)
|
||||
* [**SSD Nodes** - Affordable VPS hosting for self-hosters](https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor)
|
||||
* [**InstaPods** - Get your app online in seconds](https://instapods.com/?utm_source=memos&utm_medium=sponsor) • [Deploy Memos in 30 Seconds](https://instapods.com/apps/memos/?utm_source=memos&utm_medium=sponsor)
|
||||
## 赞助商
|
||||
* [**CodeRabbit** —— 立即将代码审查时间和 Bug 减少一半](https://coderabbit.link/usememos)
|
||||
* [**SSD Nodes** —— 面向自托管者的经济型 VPS 主机](https://ssdnodes.com/?utm_source=memos&utm_medium=sponsor)
|
||||
* [**InstaPods** —— 数秒内让应用上线](https://instapods.com/?utm_source=memos&utm_medium=sponsor) • [30 秒内部署 Memos](https://instapods.com/apps/memos/?utm_source=memos&utm_medium=sponsor)
|
||||
|
||||
Love Memos? [Sponsor us on GitHub](https://github.com/sponsors/usememos) to help keep the project growing!
|
||||
喜欢 Memos?在 [GitHub 上赞助我们](https://github.com/sponsors/usememos)),帮助项目持续成长!
|
||||
|
||||
## Star History
|
||||
## Star 历史
|
||||
|
||||
[](https://star-history.com/#usememos/memos&Date)
|
||||
[](https://star-history.com/#usememos/memos&Date)
|
||||
|
||||
## License
|
||||
## 许可证
|
||||
|
||||
Memos is open-source software licensed under the [MIT License](LICENSE). See our [Privacy Policy](https://usememos.com/privacy) for details on data handling.
|
||||
Memos 是基于 [MIT 许可证](LICENSE) 的开源软件。数据处理详情请参阅我们的[隐私政策](https://usememos.com/privacy))。
|
||||
|
||||
---
|
||||
|
||||
**[Website](https://usememos.com)** • **[Documentation](https://usememos.com/docs)** • **[Demo](https://demo.usememos.com/)** • **[Discord](https://discord.gg/tfPJa4UmAv)** • **[X/Twitter](https://x.com/usememos)**
|
||||
**[网站](https://usememos.com)** • **[文档](https://usememos.com/docs)** • **[演示](https://demo.usememos.com/)** • **[Discord](https://discord.gg/tfPJa4UmAv)** • **[X/Twitter](https://x.com/usememos)**
|
||||
|
||||
<a href="https://vercel.com/oss">
|
||||
<img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge.svg" />
|
||||
<img alt="Vercel 开源项目计划" src="https://vercel.com/oss/program-badge.svg" />
|
||||
</a>
|
||||
USD 预算:$0/$3;剩余 $3。
|
||||
|
||||
Reference in New Issue
Block a user