janniklorenz / MarkPad

Realtime Markdown Viewer

MarkPad

What is this?

Type your markdown into the box on the left and immediately see if on the box on the right. If you send a friend a link to this URL you both can edit the document at the same time!

How to use this?

Type anything after the slash in "https://realtimemarkdown.herokuapp.com/" and just start typing. If you don't feel typing in the address bar, feel free to go to one of these markdown pads:

• https://realtimemarkdown.herokuapp.com/sample
• https://realtimemarkdown.herokuapp.com/my_project
• https://realtimemarkdown.herokuapp.com/whatever

How was this built?

This website uses the following to work:

Link	Description
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

TODOs

GUI

• Syntax highlighting
• Menubar
  • Current editing users
    • Possible with sharejs?
  • Name
  • etc.
  • Download currend file add name.md
• View only mode (Segmented control, with 3 states)

Core

• Add support to multiple database types
• Source Control
• API
  • Add new pad
  • Edit content
• /new: Generate uniqe name
• Default MarkPad file

License

The MIT License