October 17, 2009 at 12:27 PM
If you’ve ever put a project on GitHub you probably know that a README file in the root folder is automatically formatted and displayed at the project page. GitHub supports different markups for this purpose, such as Markdown, RDoc, Textile or reStructured Text.
I realized that it might come in handy to have a preview of what such a file would look like when rendered to HTML while editing it. That’s what I created my little toy project Markup Preview for. It’s a pretty simply web app which allows you to enter your markup (currently only Markdown and Textile are supported) on the left pane and see the rendered result immediately (well, almost) at the right pane.
I know that there are plenty of online converters for Markdown and Textile. Anyway, this one was fun to do, plus it adds kind-of realtime preview which is not common for those converters.
Here’s what it looks like in action (rendering its own README.md file):
I installed the app at http://markup.andreloker.de so feel free to give it a try.
The project is open source and available at GitHub.com. Feedback is appreciated.