GitHub Wiki Single Page
A Ruby tool that renders a multi-page GitHub wiki into one themed HTML page using redcarpet, Bootstrap/Bootswatch themes and highlight.js, deployable to Heroku; built in December 2015 to publish the Tipsy docs.
- BPM
- 188
- GRADE
- B
- LEVEL
- 8
- RELEASES
- 3
- YEARS
- 2015–2015
Docs In A Weekend
Tipsy had a GitHub wiki full of documentation and no good way to show it off. GitHub wikis are separate pages inside GitHub's own layout, and I wanted one themed page that looked like real documentation.
So on December 11th, 2015 I started writing one in Ruby, using redcarpet to render the markdown, Bootstrap and Bootswatch for themes, and highlight.js for code blocks. It cloned the wiki, read the custom sidebar to decide which pages to include and in what order, and rendered it all into one HTML file. There was a deploy to Heroku button and four environment variables: which wiki to pull, whether to cache the clone in a tmp dir, and the default Bootswatch and highlight.js themes. v1.0.0 shipped the next day, v1.0.1 on the 15th, and that was it.
I'd just cut Tipsy v0.11.0 four days earlier and had spent the previous two weeks building example apps for it, and this gave the docs a nice home.
led to
- tishdoc2026wiki markdown rendered to one HTML page