Skip to content

realtime markdown editor which enable user to write markdown text on left and display it on right side

Notifications You must be signed in to change notification settings

ashikkabeer/realtime-markdown-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Realtime Markdown Editor

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.

Features

  • 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.

Getting Started

Prerequisites

  • Node.js installed on your machine
  • Redis server running (for ShareJS)

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/realtime-markdown-editor.git
  2. Navigate to the project directory:

    cd realtime-markdown-editor
  3. Install dependencies:

    npm install

Usage

  1. Start the server:

    npm start

    The server will run on http://localhost:8000 by default.

  2. Open your web browser and go to the provided URL.

  3. Begin editing and see the changes in real-time.

Technologies Used

  • 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

Acknowledgments

Feel free to contribute and make this project even better!

About

realtime markdown editor which enable user to write markdown text on left and display it on right side

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published