https://github.com/smaug6739/alexandrie
Alexandrie is a fast, modern, and open-source web application for Markdown note taking, designed for students, creators, and knowledge workers seeking a productive and flexible tool. Build structured notes using an extended Markdown syntax, organize them with workspaces and categories, and work seamlessly both online and offline.
https://github.com/smaug6739/alexandrie
collaborate editor go golang markdown note note-taking notes nuxt organization productivity self-hosted vue
Last synced: 4 months ago
JSON representation
Alexandrie is a fast, modern, and open-source web application for Markdown note taking, designed for students, creators, and knowledge workers seeking a productive and flexible tool. Build structured notes using an extended Markdown syntax, organize them with workspaces and categories, and work seamlessly both online and offline.
- Host: GitHub
- URL: https://github.com/smaug6739/alexandrie
- Owner: Smaug6739
- License: mit
- Created: 2022-08-21T06:11:39.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-24T16:39:32.000Z (4 months ago)
- Last Synced: 2026-01-25T04:55:38.374Z (4 months ago)
- Topics: collaborate, editor, go, golang, markdown, note, note-taking, notes, nuxt, organization, productivity, self-hosted, vue
- Language: Vue
- Homepage: https://alexandrie-hub.fr
- Size: 65.5 MB
- Stars: 1,037
- Watchers: 9
- Forks: 65
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Alexandrie – The Ultimate Note-Taking App
A modern and elegant application for taking notes in extended Markdown.
Organize, search, and export your notes with an intuitive interface designed for students and productivity.
[](https://github.com/Smaug6739/Alexandrie/stargazers)
[](https://github.com/Smaug6739/Alexandrie/issues)
[](https://github.com/Smaug6739/Alexandrie/blob/main/LICENSE)
[](https://github.com/Smaug6739/Alexandrie/pulls)
[](https://github.com/Smaug6739/Alexandrie/releases)
[](https://discord.gg/UPsEg6egPj)
## ✨ Features
- **Enhanced Markdown Editor** – Write notes with advanced and unique Markdown features.
- **Instant Search** – Find your notes in seconds.
- **Intuitive Organization** – Easily categorize and archive your notes with a complete sidebar, workspaces, categories, nested documents / categories, tags...
- **Export & Print** – Save your notes as PDF, Markdown, and more.
- **Access Anywhere** – Log in and retrieve your notes from any device. Use the PWA to access your notes offline.
- **Share Notes** – Share your notes with others via unique links or powerful permissions system.
---
## Interface Preview
### Share your notes, collaborate with others, manage permissions.
## Quick Start with Docker
For local testing and development, you can use Docker to run the entire stack:
**Start a demo server:**
- Download the [docker-compose.yml](./docker-compose.yml) file.
- Download the [.env.example](./.env.example) file and rename it to `.env`, then adjust any environment variables as needed. _Default settings should work out of the box._
```bash
docker compose up
```
**Start a development server with hot reloading (HMR, and need to clone the repo):**
```bash
docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build
```
For complete setup instructions, please refer to the [Setup Documentation](./docs/README.md).
**Access points:**
- **Frontend**: http://localhost:8200
- **Backend API**: http://localhost:8201
- **Object Storage Console**: http://localhost:9000
- **MySQL**: localhost:3307 (user: `alexandrie`, password: `password`)
**To stop:**
```bash
docker compose down
```
_The project support S3 compatible storage. The default in docker-compose is RustFS but you can use MinIO, garage, etc._
If you don't have Docker installed, you can follow the manual setup instructions in the [CONTRIBUTING.md](./CONTRIBUTING.md).
## Contributing
This project has an MIT license. And you are welcome to contribute.
For more details on contributions, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
> Thank you to everyone who contributes to the project. 🎉