A powerful, real-time collaborative Markdown editor inspired by Google Docs and Overleaf. Built with React, Phoenix, and Haskell, this project brings team-based editing to the next level with custom .mds
format support, Unsplash image embeds, and live synchronization.
-
Real-Time Collaboration:
Edit Markdown documents with your team simultaneously. See cursors and edits in real-time. -
Custom
.mds
Format:
Extend Markdown with powerful features:!title[Your Title]
: Add beautiful document titles.!gif[search term]
: Embed GIFs on the fly.!image[unsplash term]
: Seamlessly add images from Unsplash.
-
Live Preview:
Instantly preview Markdown-rendered content as you type. -
Unsplash Integration:
Quickly embed stunning, royalty-free images. -
History Tracking:
Built-in undo/redo functionality.
Component | Technology |
---|---|
Frontend | React, CodeMirror, react-markdown |
Backend | Phoenix Framework |
Parser | Haskell + Pandoc |
Database | PostgreSQL |
APIs | Unsplash API |
- Share your document with team members. All changes are synchronized in real-time.
- Add titles:
!title[My Document Title]
- Embed a GIF:
!gif[coding cat]
- Add an Unsplash image:
!image[forest]
Ctrl + Z
: UndoCtrl + Y
: RedoCtrl + S
: Save Document
markdown-docs/
├── frontend/ # React frontend
├── backend/ # Phoenix backend
├── parser/ # Haskell-based .mds parser
└── docs/ # Project documentation
We welcome contributions! Follow these steps to get started:
- Fork the repository.
- Create a feature branch (
git checkout -b feature/awesome-feature
). - Commit your changes (
git commit -m "Add awesome feature"
). - Push to the branch (
git push origin feature/awesome-feature
). - Open a pull request.
- Basic Markdown editor with live preview.
- Real-time collaboration with WebSocket support.
- Custom
.mds
parser in Haskell. - Unsplash API integration.
- Export to PDF.
- Mobile-friendly UI.
This project is licensed under the Apache License 2.0.
Coming soon...
For questions or feedback, feel free to open an issue.