Jekyll Page generator for Inch Pages
Ruby CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes
_layouts
_plugins
public
.gitignore
.ruby-gemset
.ruby-version
404.html
Gemfile
Gemfile.lock
README.md
Rakefile
TODOS.md
_config.yml
_popular.yml
_projects.yml
imprint.html
index.html
participate.html
repo.html

README.md

Inch Pages

Documentation badges for Ruby projects Inline docs

Inch Pages is based on Inch, the documentation measurement tool for Ruby.

Advantages for maintainers

If you are a gem developer or maintain a library you probably already use badges in your README to show that your tests are passing and your code isn't a horrible mess in need of refactoring.

Now you can also show that you documented your project properly.

Click here to request a badge for your project

Advantages for developers

If you are a Ruby developer, you know the pain of cloning a project you want to improve just to find out that it is completely undocumented.

Then you have to form the mental equivalent of an AST to comprehend how it all fits together. Wouldn't it be great to see the present level of documentation directly in the README?

Further reading: http://inch-pages.github.io