Skip to content

Previewing tool for your GitHub README files. Supports popular formats like rdoc, markdown, textile, wiki, etc

License

Notifications You must be signed in to change notification settings

ghamed/github-markup-preview

 
 

Repository files navigation

Hello. This is the GitHub Markup Preview.

I know you've been missing it - simple tool that allows you to edit and instantly preview your README files before committing them.

Take a look at the demo here.

This preview on the right side looks exactly the same as it would look like on GitHub.

Refresh the page. Your markup stays here until you close the browser tab. Isn't that great?

Supported formats are:

  • github flavored markup
  • simple markdown
  • rdoc
  • textile
  • wiki
  • org
  • creole

I want to contribute

Contact me on GitHub

Thanks to

GitHub Markup developers - this application totally depends on their library.

License

MIT License - fork, modify and use however you want.

Analytics

About

Previewing tool for your GitHub README files. Supports popular formats like rdoc, markdown, textile, wiki, etc

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 43.9%
  • JavaScript 36.8%
  • CSS 19.3%