Giter Club home page Giter Club logo

gfmarkdowneditor's Introduction

GFMarkdown Editor

This is an online Markdown editor with live preview.

Its specificity is to support Github Flavored Markdown: I was not able to find any tool for it, except the inline editor on Github website (but you can't have at the same time the editor and the preview!).

It uses Github API to get a preview. Anonymous users are limited to 60 requests/hour. You can login using your Github credentials to get up to 5000 requests/hour.

Other features include a decent editor (using Ace Editor), with syntax highlighting, the ability to save a document to localStorage (automatically when you try to leave the page), access to GFM cheat sheet.

Quick install

It uses Twitter Bower to fetch assets, just run bower install

From a local webserver, everything should run fine. Just open index_dev.html with a browser. Note: it seems Github, as of 2013-03-03, does not allow anymore localhost host for requests, unless you are logged in.

To use it from a webdomain, as documented here, you must register your application on Github as an OAuth application (fill up the form, the callback URL doesn't really matter).

Credits

A few very handy libraries were used:

Finally, it relies on Github v3 API. Of course this readme was made using it!

gfmarkdowneditor's People

Contributors

romaricdrigon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

gobb paucoma nunb

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.