This project is a simple realtime Markdown editor built using Express, ShareJS, and Showdown.js. It allows users to collaboratively edit and preview Markdown content in real-time.
- Realtime collaboration: Multiple users can simultaneously edit and view Markdown content.
- Markdown Preview: A live preview of the Markdown content is displayed as users type.
- Shareable URLs: Each document has a unique URL that can be shared for collaborative editing.
- Node.js installed on your machine
- Redis server running (for ShareJS)
-
Clone the repository:
git clone https://github.com/your-username/realtime-markdown-editor.git
-
Navigate to the project directory:
cd realtime-markdown-editor
-
Install dependencies:
npm install
-
Start the server:
npm start
The server will run on http://localhost:8000 by default.
-
Open your web browser and go to the provided URL.
-
Begin editing and see the changes in real-time.
- Express.js: Web application framework for Node.js
- ShareJS: Real-time collaboration library
- Showdown.js: Markdown to HTML converter
- Bootstrap: Front-end framework
- Redis: Backend data store for ShareJS
Feel free to contribute and make this project even better!