Skip to content

kylozw/markdown-plus

 
 

Repository files navigation

Markdown Plus

Markdown Plus Markdown Plus is a lightweight markdown editor. Besides common markdown, GitHub flavored markdown, it also supports task lists, emojis, Font Awesome icons, Ionicons icons, Mathematical formulae, flowcharts and sequence diagrams.

Features

  • Simple, only a few handred lines of code
  • GitHub flavored markdown
  • Realtime preview
  • Source code highlight
  • Task lists
  • Emojis
  • Font Awesome icons
  • Ionicons icons
  • Mathematical formulae
  • Flowcharts
  • Sequence diagrams

Markdown Plus

Why yet another markdown editor?

We had tried several of the markdown editors available on GitHub, they are either too simple in features or too complex in implementation.

We spent too much time finding, hacking and tweaking other markdown editors and finally we decided to create our own.

We hope Markdown Plus could save your time when you need a simple yet feature-rich markdown editor.

Setup & Run

git clone https://github.com/tylingsoft/markdown-plus.git && cd markdown-plus
bower install
open index.html

How to use Markdown Plus in your projects

Please take index.html as an example.

License

The BSD 3-Clause License

Copyright (c) 2015 Tylingsoft




Below is for Chinese speaking

Markdown Plus

Markdown Plus 是一款轻量级 markdown 编辑器。除了支持通用 markdown、GitHub flavored markdown,它还支持任务列表、Emoji 图标、Font Awesome 图标、Ionicons 图标、数学公式、流程图、顺序图。

主要特性

  • 简单,仅有几百行代码
  • GitHub flavored markdown
  • 实时预览
  • 代码高亮
  • 任务列表
  • Emoji 图标
  • Font Awesome 图标
  • Ionicons 图标
  • 数学公式
  • 流程图
  • 顺序图

为什么又一个 markdown 编辑器?

我们曾试过 GitHub 上面的几个 markdown 编辑器,对我们来讲它们不是功能上太简单了就是实现上太复杂了。

我们把大量的时间花在了寻找、修改、定制其它的 markdown 编辑器上,直到最终我们决定自己写一个。

我们希望 Markdown Plus 能给那些需要一个既简单又功能完备的 markdown 编辑器的人节省时间。

安装与运行

git clone https://github.com/tylingsoft/markdown-plus.git && cd markdown-plus
bower install
open index.html

如何在项目中使用

参考index.html,比葫芦画瓢。

软件协议

BSD 协议

版权所有 (c) 2015 Tylingsoft

About

Markdown editor with extra features.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 51.8%
  • HTML 40.5%
  • CSS 7.7%