Skip to content

A live markdown to HTML / Text convertor built to preview markdown ( .md ) files before making attractive README files.

Notifications You must be signed in to change notification settings

Adityasinghvats/Visual-MarkDown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Realtime Markdown Editor 🪃 😸

What is this?

Type your markdown into the box on the left and immediately see if on the box on the right.

The editor has the capacity for realtime collaboration using ShareJS.

How to use this? 🔽

  • Clone the repo using

    git clone https://github.com/Adityasinghvats/Visual-MarkDown.git
  • Open the project in VS Code and go the root directory.

  • Run the server using

    node server.js
  • Access the editor at localhost:8000.

How was this built? 🤔

This website uses the following to work:

  • Showdown - Converts markdown text to beautiful HTML
  • ShareJS - allows for realtime editing of this textbox
  • Node.js - backend framework
  • Redis - where we store our markdown documents
  • Twitter Bootstrap - makes everything a little prettier

Demo 😲

Screenshot 2025-01-23 140558

About

A live markdown to HTML / Text convertor built to preview markdown ( .md ) files before making attractive README files.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published