mirror of
https://github.com/usememos/memos.git
synced 2024-12-25 22:51:29 +08:00
58 lines
3.1 KiB
Markdown
58 lines
3.1 KiB
Markdown
<img height="56px" src="https://www.usememos.com/full-logo-landscape.png" alt="Memos" />
|
||
|
||
A privacy-first, lightweight note-taking service. Easily capture and share your great thoughts.
|
||
|
||
<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> •
|
||
<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>
|
||
|
||
|
||
|
||
## Key points
|
||
|
||
- **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.
|
||
|
||
## Deploy with Docker in seconds
|
||
|
||
```bash
|
||
docker run -d --name memos -p 5230:5230 -v ~/.memos/:/var/opt/memos neosmemo/memos:stable
|
||
```
|
||
|
||
> 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.
|
||
|
||
Learn more about [other installation methods](https://www.usememos.com/docs/install).
|
||
|
||
## Contribution
|
||
|
||
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! 🥰
|
||
|
||
<a href="https://github.com/usememos/memos/graphs/contributors">
|
||
<img src="https://contri-graphy.yourselfhosted.com/graph?repo=usememos/memos&format=svg" />
|
||
</a>
|
||
|
||
## 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>
|
||
|
||
## Star history
|
||
|
||
[](https://star-history.com/#usememos/memos&Date)
|
||
|
||
## Other projects
|
||
|
||
- [**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.
|