Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 2.01 KB

README.md

File metadata and controls

92 lines (61 loc) · 2.01 KB
Raw

CollaboMarker

A Collaborative real-time markdown editor.

This is beta version software.

Deploy

Capture

aa

Features

The current version of Collabo Marker provides a basic features below:

  • Collaborative edit
  • Live markdown preview
  • Sync scroll between editor and preview
  • Chat with collaborators

Beta version caution

Do not support IME input officially

If you want to input Japanese, Chinese or other language which needs IME, try to access Collabo Marker with request parameter ime-enabled=true . But please note that there are a lot of bugs...

http://localhost:4000/?ime-enabled=true

Do not ensure perfect document sync

When a lot of changes happens at the same time, documents may lose their Idempotence.

How to start

Your local

First of all, install softwares below.

  • elixir
  • phoenix
  • npm

And then

$ git clone https://github.com/mserizawa/collabo_marker.git
$ cd collabo_marker/
$ npm install
$ mix deps.get
$ elixir --detached -S mix phoenix.server

Now you can use CollaboMarker on http://localhost:4000/ .

Heroku

Use Deploy to Heroku button and enjoy.

Recommended browser

  • Chrome: latest
  • Firefox: latest
  • Safari: latest

TODO

  • Implement cursor rendering function
  • Substitute Angularjs for jQuery
  • Implement markdown preview function
  • Implement logined user management function
  • Implement login function
  • Implement content share function
  • Implement chat function
  • Fix layout
  • Synchronize scrollTop between editor and preview
  • Hide cursors on load
  • Save login status to cookie
  • Keep user names unique
  • Improve login UX
  • Show join / disconnected message
  • Remove unnecessary files
  • Write README
  • Put 'Deploy to Heroku'
  • Fix the bug of losing others inputs
  • Support IME input officially