https://github.com/nikolas/markdown-toolbar

A clone of GitHub's markdown toolbar
https://github.com/nikolas/markdown-toolbar

commonmark markdown-toolbar

Last synced: about 2 months ago
JSON representation

A clone of GitHub's markdown toolbar

• Host: GitHub
• URL: https://github.com/nikolas/markdown-toolbar
• Owner: nikolas
• License: gpl-3.0
• Created: 2016-04-29T20:28:41.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-07T15:41:21.000Z (about 1 year ago)
• Last Synced: 2024-10-20T14:42:17.100Z (12 months ago)
• Topics: commonmark, markdown-toolbar
• Language: JavaScript
• Homepage: https://nikolas.github.io/markdown-toolbar/
• Size: 408 KB
• Stars: 23
• Watchers: 3
• Forks: 11
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: COPYING

Awesome Lists containing this project

README

          
# markdown-toolbar [![Build Status](https://travis-ci.org/nikolas/markdown-toolbar.svg?branch=master)](https://travis-ci.org/nikolas/markdown-toolbar)

[![Greenkeeper badge](https://badges.greenkeeper.io/nikolas/markdown-toolbar.svg)](https://greenkeeper.io/)

markdown-toolbar can be used as a jQuery plugin that provides a WYSIWYG experience using Markdown syntax. markdown-toolbar requires [commonmark.js](https://github.com/jgm/commonmark.js), and also uses [js-emoji](https://github.com/iamcal/js-emoji) if it's available. Calling `.markdownToolbar()` on a textarea creates a toolbar above the textarea, and a rendered preview below it, like this:

![markdown-toolbar screenshot](http://www.columbia.edu/~njn2118/journal/img/markdown-toolbar.png)

* Demo: https://nikolas.github.io/markdown-toolbar/

* Background info: http://www.columbia.edu/~njn2118/journal/2016/2/12.html

## Usage

```js

$('textarea.markdown-toolbar').markdownToolbar();

```