Skip to content

xiaoyanhao/markdown-editor

Repository files navigation

GitHub Flavored Markdown Editor

A simple, convenient and efficient github flavored markdown editor based on react, marked and highlight.js.

Features

  • Clean and collapsible UI.
  • Instant preview and simultaneous update.
  • Synchronized scroll between editor and preview.
  • Support uploading local images.
  • Provide shortcut buttons for different functions.
  • Automatically save the draft when closing the window.
  • Save the draft as markdown file.
  • Export preview as PDF file for Chrome and Safari (⌘p or ⌃p).

Warning: the syntaxes of tasklist, emoji and indented code are not supported in maked compiler.

Development

  1. npm install && bower install.
  • run gulp and open http://localhost:3000/ to start automation workflow.
  • run gulp clean to delete dist directory for some obsolete files might be cached.
  • run gulp deploy to publish contents to github page.

Usage

  1. Get started with writing and formatting on github tutorial.
  2. For more information, see Daring Fireball's "Markdown Syntax".
  3. Already familiar with the above? Go head and write!

License

Under the MIT license. See LICENSE file for more details.

About

A simple, convenient and efficient github flavored markdown editor.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published