Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Guide'em up is a tool for writing guides in markdown
Ruby
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
data
lib
spec
.autotest
.gitignore
Gemfile
MIT-LICENSE
README.md
guide-em-up.gemspec

README.md

Guide'em up

Guide'em up is a tool for writing guides in markdown. It generates an HTML document that you can share easily, it's just one file after all!

How to use it?

It's really simple:

  1. Install it with gem install guide-em-up
  2. Write your guide in markdown
  3. Launch guide-em-up and open http://localhost:9000 in your browser
  4. Select your guide and enjoy :-)

You must also install pygments if you want syntax highlighting.

Issues or Suggestions

Found an issue or have a suggestion? Please report it on Github's issue tracker.

If you wants to make a pull request, please check the specs before:

./spec/guide-em-up_spec.rb

Credits

The CSS and images for the browser are based on h5ai, a beautified Apache index.

♡2011 by Bruno Michel. Copying is an act of love. Please copy and share. Released under the MIT license

Something went wrong with that request. Please try again.