Home > Readme-Markdown-Previewer

Readme-Markdown-Previewer

Readme-Markdown-Previewer is a project mainly written in ..., it's free.

Simple script to preview your README.md file in a sample GitHub project page.

Readme Markdown Previewer

Readme Markdown Previewer allows you to quickly and easily preview your README.md. The preview.html loads the readme.md file, converts it using a showdown.js (modified for github flavored markdown), then loads it. The preview.html is a stripped down version of the a GitHub project page so it has the correct look and feel.

Usage

Simply download 'preview.html' to the root of your project and point your browser to preview.html. The script will load "readme.md" and preview it.

To-Do

Modify script to accept filename and interval parameters.

Test Markdown

The following markdown copied from:

http://github.github.com/github-flavored-markdown/preview.html

Underscores

this should have emphasis this_should_not _nor_should_this

Autolinking

a non-markdown link: http://github.com/blog this one is a markdown link Email test: [email protected]

Commit links

c4149e7bac80fcd1295060125670e78d3f15bf2e tekkub@c4149e7bac80fcd1295060125670e78d3f15bf2e mojombo/god@c4149e7bac80fcd1295060125670e78d3f15bf2e

Issue links

issue #1 tekkub#1 mojombo/god#1