Project

githubreadme-to-html

0.0

No commit activity in last 3 years

No release in over 3 years

githubreadme-to-html mickeyren/githubreadme-to-html Homepage Documentation Source Code Bug Tracker Wiki

Use this tool so you can see a preview of your README on how it will look like on GitHub.

2005

2006

2007

2008

2009

2010

2011

2012

2013

2014

2015

2016

2017

2018

2019

2020

2021

2022

2023

2024

Popularity

7,722

Releases

1.0.2

2012-10-22

2012-10-29

Development

Primary Language

Ruby

Average date of last 50 commits

2012-10-26

Reverse Dependencies

Dependencies

Runtime

github-markup

>= 0

Project Readme

GitHub Readme To Html¶ ↑

Convert your GitHub readme compatible markup into html files

Installation¶ ↑

You can use latest gem:

gem install githubreadme-to-html

Usage¶ ↑

Use this tool so you can see a preview of your README on how it will look like on GitHub.

gth <filename.ext>

Example

gth README.rdoc

will generate and open a README.html into your default browser.

Additional note¶ ↑

This tool uses GitHub Markup - github.com/github/markup so should support all markup files listed on their GitHub page.