view github based project wiki offline
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
1.PNG
2.PNG
Gemfile
LICENSE.txt
README.md
Rakefile
blogdown.gemspec

README.md

Blogdown

Build Status

Coverage Status

What this is all about

Blogdown helps to view your favorite github wiki offline. I created this project to help me, have a good source of documentation on my pc, since I dont have the privilege of internet access. I go online once in a while, and its frusttating when I ineed to go online to view documentation.

Installation

Run:

$ gem install blogdown

Usage

Clone your favorite wiki

$ git clone [The Wiki URL goes HERE]

Cd into your wiki directory

$cd mywiki.wiki

And, blog it down

$ blogdown server

Behing the scene, the command will build the project first, and run a webserver which will be available at http://localhost:4567 copy http://localhost:4567 and paste into your browser to see the files and view them with much more options.

Snapshots

blogdown

blogdown

Contributing

  1. Fork it ( https://github.com/gernest/blogdown/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request