https://github.com/ether/ep_markdown

See edits as markdown in Etherpad
https://github.com/ether/ep_markdown

Last synced: 9 months ago
JSON representation

See edits as markdown in Etherpad

• Host: GitHub
• URL: https://github.com/ether/ep_markdown
• Owner: ether
• License: apache-2.0
• Created: 2013-03-25T20:15:59.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2024-08-18T16:40:37.000Z (over 1 year ago)
• Last Synced: 2025-03-20T09:47:40.950Z (11 months ago)
• Language: TypeScript
• Homepage:
• Size: 338 KB
• Stars: 69
• Watchers: 6
• Forks: 24
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Publish Status](https://github.com/ether/ep_markdown/workflows/Node.js%20Package/badge.svg) ![Backend Tests Status](https://github.com/ether/ep_markdown/workflows/Backend%20tests/badge.svg)

Markdown editing in Etherpad

============================

![Alt Text](http://i.imgur.com/bGZHFqH.gif "ep_markdown in action")

Features

========

* Use the normal editbar buttons to add markdown.

* Import as Markdown (automatically applies styling / text attributes).

* Export as Markdown.

* Localizations.

Usage

=====

To enable Markdown view click Settings -> Markdown

Limitations

===========

This plugin is not designed for you to write Markdown and it format that markdown with styling.  So you can't expect to type \*\*blah\*\* and expect to see blah in bold.  You can however type blah, set it as bold and then click "Show as Markdown" and it will show \*\*bold\*\*.  I will not be adding support for supporting typing in markdown which will render to a style because it will be impossible to handle character control.

Setting as default

==================

Paste the below into your settings.

"ep_markdown_default": true,

Todo

====

* Support ALL styles fully (please let me know what does / doesn't work)

* Create markdown icon for export menu

* Better code block support (currently it's line by line)

* Import Markdown (and it applies formatting automatically)

Requirements

============

Etherpad 1.8.1