memos/README.md

63 lines
3.1 KiB
Markdown
Raw Normal View History

2022-09-01 07:36:14 +08:00
<p align="center"><a href="https://usememos.com"><img height="64px" src="https://raw.githubusercontent.com/usememos/memos/main/resources/logo-full.webp" alt="✍️ memos" /></a></p>
2022-01-17 08:42:36 +08:00
<p align="center">
2022-07-29 21:39:52 +08:00
<a href="https://github.com/usememos/memos/stargazers"><img alt="GitHub stars" src="https://img.shields.io/github/stars/usememos/memos" /></a>
2022-07-09 14:09:40 +08:00
<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://hosted.weblate.org/engage/memos/"><img src="https://hosted.weblate.org/widgets/memos/-/svg-badge.svg" alt="Translation status" /></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
<p align="center">
2022-07-23 19:47:14 +08:00
<a href="https://demo.usememos.com/">Live Demo</a>
Discuss in <a href="https://t.me/+-_tNF1k70UU4ZTc9">Telegram</a> / <a href="https://discord.gg/tfPJa4UmAv">Discord</a>
</p>
2021-12-08 23:43:14 +08:00
2023-03-05 01:18:30 +08:00
![demo](https://usememos.com/demo.webp)
2023-03-05 21:33:57 +08:00
## Key points
2023-03-05 21:33:57 +08:00
- Open source and free forever
- Self-hosting with Docker in seconds
- Markdown support
- Customizable and sharable
- RESTful API for self-service
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
2022-08-22 20:52:54 +08:00
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:latest
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-03-05 21:33:57 +08:00
Learn more about [other installation methods](https://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">
<img src="https://contrib.rocks/image?repo=usememos/memos" />
</a>
2022-10-30 14:42:56 +08:00
2023-03-05 21:33:57 +08:00
Here are some products made by our community:
2022-10-30 14:42:56 +08:00
- [Moe Memos](https://memos.moe/) - Third party client for iOS and Android
2022-11-01 23:09:17 +08:00
- [lmm214/memos-bber](https://github.com/lmm214/memos-bber) - Chrome extension
2022-12-03 15:01:27 +08:00
- [Rabithua/memos_wmp](https://github.com/Rabithua/memos_wmp) - WeChat MiniProgram
2022-11-01 23:09:17 +08:00
- [qazxcdswe123/telegramMemoBot](https://github.com/qazxcdswe123/telegramMemoBot) - Telegram bot
2023-03-05 21:33:57 +08:00
- [eallion/memos.top](https://github.com/eallion/memos.top) - Static page rendered with the Memos API
- [eindex/logseq-memos-sync](https://github.com/EINDEX/logseq-memos-sync) - Logseq plugin
- [JakeLaoyu/memos-import-from-flomo](https://github.com/JakeLaoyu/memos-import-from-flomo) - Import data. Support from flomo, wechat reading
- [Send to memos](https://sharecuts.cn/shortcut/12640) - A shortcut for iOS
- [Memos Raycast Extension](https://www.raycast.com/JakeYu/memos) - Raycast extension
- [Memos Desktop](https://github.com/xudaolong/memos-desktop) - Third party client for MacOS and Windows
## Acknowledgements
- Thanks [Uffizzi](https://www.uffizzi.com/) for sponsoring preview environments for PRs.
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)