Git Product home page Git Product logo

inch-pages's Introduction

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

inch-pages's People

Contributors

rrrene avatar sferik avatar splattael avatar alakra avatar soulcutter avatar jwaldrip avatar thejchap avatar pboling avatar smalllars avatar yasuhito avatar bf4 avatar docwhat avatar webhat avatar denisdefreyne avatar iliabylich avatar jamesrwhite avatar jodosha avatar ms-ati avatar msdark avatar miah avatar muriel-salvan avatar nledez avatar njonsson avatar rafehatfield avatar futhr avatar razum2um avatar whoward avatar lkdjiin avatar andreasknoepfle avatar dnlbauer avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.