memos/README.md

59 lines
3.1 KiB
Markdown
Raw Normal View History

2023-11-21 20:39:48 +08:00
<img height="56px" src="https://www.usememos.com/full-logo-landscape.png" alt="Memos" />
2023-07-14 00:00:08 +08:00
A privacy-first, lightweight note-taking service. Easily capture and share your great thoughts.
2023-10-26 09:00:36 +08:00
<a href="https://www.usememos.com">Home Page</a>
<a href="https://www.usememos.com/blog">Blogs</a>
<a href="https://www.usememos.com/docs">Docs</a>
2023-10-25 07:43:52 +08:00
<a href="https://demo.usememos.com/">Live Demo</a>
<p>
<a href="https://hub.docker.com/r/neosmemo/memos"><img alt="Docker pull" src="https://img.shields.io/docker/pulls/neosmemo/memos.svg"/></a>
<a href="https://discord.gg/tfPJa4UmAv"><img alt="Discord" src="https://img.shields.io/badge/discord-chat-5865f2?logo=discord&logoColor=f5f5f5" /></a>
</p>
2022-01-17 08:42:36 +08:00
2024-01-18 19:06:49 +08:00
![demo](https://www.usememos.com/demo.png)
2023-03-05 21:33:57 +08:00
## Key points
2023-07-14 00:00:08 +08:00
- **Open source and free forever**. Embrace a future where creativity knows no boundaries with our open-source solution free today, tomorrow, and always.
- **Self-hosting with Docker in just seconds**. Enjoy the flexibility, scalability, and ease of setup that Docker provides, allowing you to have full control over your data and privacy.
- **Pure text with added Markdown support.** Say goodbye to the overwhelming mental burden of rich formatting and embrace a minimalist approach.
- **Customize and share your notes effortlessly**. With our intuitive sharing features, you can easily collaborate and distribute your notes with others.
- **RESTful API for third-party services.** Embrace the power of integration and unleash new possibilities with our RESTful API support.
2022-04-03 21:54:54 +08:00
2023-03-05 21:33:57 +08:00
## Deploy with Docker in seconds
2023-03-05 21:33:57 +08:00
```bash
2024-01-18 19:06:49 +08:00
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:stable
2022-05-01 11:06:29 +08:00
```
2022-04-03 21:54:54 +08:00
2023-03-05 21:33:57 +08:00
> The `~/.memos/` directory will be used as the data directory on your local machine, while `/var/opt/memos` is the directory of the volume in Docker and should not be modified.
2023-10-26 09:00:36 +08:00
Learn more about [other installation methods](https://www.usememos.com/docs/install).
2023-03-05 21:33:57 +08:00
## Contribution
2022-04-03 22:14:43 +08:00
2023-03-05 21:33:57 +08:00
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. We greatly appreciate any contributions you make. Thank you for being a part of our community! 🥰
2022-04-03 22:14:43 +08:00
2023-03-05 21:33:57 +08:00
<a href="https://github.com/usememos/memos/graphs/contributors">
2023-11-29 09:00:29 +08:00
<img src="https://contri-graphy.yourselfhosted.com/graph?repo=usememos/memos&format=svg" />
2023-03-05 21:33:57 +08:00
</a>
2022-10-30 14:42:56 +08:00
2024-03-13 08:25:38 +08:00
## Internationalization
Memos supports multiple languages. You can help us translate Memos into your language. We use Weblate to manage translations.
<a href="https://hosted.weblate.org/engage/memos-i18n/">
<img src="https://hosted.weblate.org/widget/memos-i18n/english/287x66-grey.png" alt="Translation status" />
</a>
2022-08-22 20:52:54 +08:00
## Star history
2022-02-04 22:00:13 +08:00
2022-07-24 13:37:07 +08:00
[![Star History Chart](https://api.star-history.com/svg?repos=usememos/memos&type=Date)](https://star-history.com/#usememos/memos&Date)
2024-02-23 08:25:54 +08:00
## Other projects
2024-02-23 08:25:54 +08:00
- [**Slash**](https://github.com/yourselfhosted/slash): An open source, self-hosted bookmarks and link sharing platform. Save and share your links very easily.
- [**Gomark**](https://github.com/yourselfhosted/gomark): A markdown parser written in Go for Memos. And its [WebAssembly version](https://github.com/yourselfhosted/gomark-wasm) is also available.