Collaborative Markdown Editor Example

Collaborative Markdown Editor built on modern and simple web technologies with markdown editing libraries integrations, which allows a few users create and edit markdowns in real time through specific `documentId` sharable link and changes can be saved in database. Can serve as a boilerplate for building your amazing app 😊.

🔍 Table of Contents

• 🚀 Features
• 📦 Installation
• 💡 Contributions
• 📄 License

🚀 Features

• Collaboriative Mardkdown editing in real time through sharable link
• Documents with their contents can be saved in database
• Documents can be resumed and accessed through their sharable url /documents/:documentId

📦 Installation

• Make sure you have Docker installed on your machine
• And run

docker compose up

Note: On older versions of Docker through dash

docker-compose up

💡 Contributions

Contributions are welcome! You can help make this example better in several ways:

• Bug Fixes: If you find any bugs, feel free to open an issue or submit a pull request to fix them.
• Feature Requests: Have an idea for a new feature or improvement? Share it by opening an issue.
• Documentation: Help improve the project's documentation to make it clearer and easier to understand.
• Testing: Write additional tests to ensure the reliability of the code.
• Code Quality: Review existing code and suggest improvements to make it more readable and maintainable.

Your contributions will make this example more user-friendly, reliable, and bug-free. Every contribution, big or small, is appreciated and will be acknowledged in the project's documentation. Read more in CONTRIBUTION.md.

📄 License

Licensed under the MIT License.