forked from rrrene/inch-pages
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
217 lines (185 loc) · 8.27 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
---
layout: default
title: Home
---
<div style="clear:both; margin-top: 1rem;">Early adopters:</div>
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://avatars.githubusercontent.com/u/1686160" width="64">
</div>
<div class="info">
<a href="/github/haml/haml"><img src="/github/haml/haml.png"></a>
<b>haml</b>
<span>HTML Abstraction Markup Language - A Markup Haiku</span>
</div>
<div style="clear:both"></div>
</div>
</div>
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://avatars.githubusercontent.com/u/845682" width="64">
</div>
<div class="info">
<a href="/github/pry/pry"><img src="/github/pry/pry.png"></a>
<b>PRY</b>
<span>An IRB alternative and runtime developer console</span>
</div>
<div style="clear:both"></div>
</div>
</div>
<div style="clear:both"></div>
<div class="repo-wrapper">
<div class="repo-card">
<div class="repo-info">
{% markdown %}
## Documentation badges for Ruby projects ![Inline docs](/public/images/badge-example.png)
### 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](/participate)
### 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?
<a target="_blank" href="http://twitter.com/intent/tweet?url=http://inch-pages.github.io/&text={{ "Documentation badges for Ruby!" | url_escape }}">Click here to spread the word</a>
{% endmarkdown %}
</div>
</div>
</div>
<div class="repo-wrapper">
<div class="repo-card">
<div class="repo-info">
<h2>FAQ</h2>
<h3>What is Inch Pages?</h3>
<p>
This project is an attempt to raise the visibility of code documentation in Ruby.
It provides <strong>badges to include in your project's README</strong>, to show people that documenting code is a cool thing.
</p>
<p>
The badges are based on Inch and look like this:
<a href="/participate"><img src="/public/images/badge-example.png"></a>
<a href="/participate">Get yours!</a>
</p>
<h3>What is Inch?</h3>
<p>
<a target="_blank" href="http://trivelop.de/inch">Inch</a> is a <strong>documentation measurement tool for Ruby</strong> that was created to help people document their code.
It is a command-line utility that gives grades based on how complete the docs are (<a target="_blank" href="http://trivelop.de/inch">screenshots</a>).
</p>
<h3>What is the goal?</h3>
<p>
I really think that posting these badges in a project's README will benefit the project (because <strong>people can see that it's well documented</strong>) and the community by improving the visibility of documentation.
</p>
<p>
Let's start a discussion, let's raise the visibility of documentation, let's talk.
</p>
<h3>Wait, who are you?</h3>
<p>
I'm <a target="_blank" href="https://twitter.com/rrrene">@rrrene</a>, creator of <a target="_blank" href="http://github.com/rrrene/sparkr">sparkr</a> and <a target="_blank" href="http://github.com/rrrene/inch">Inch</a>.
</p>
<p>
<a target="_blank" href="https://twitter.com/rrrene">Hit me up on Twitter</a> or <a target="_blank" href="{{ site.inch_pages.new_issue_url }}">create an issue</a> in the Inch Pages project.
</p>
</div>
</div>
</div>
<!--
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://avatars.githubusercontent.com/u/351846" width="64">
</div>
<div class="info">
<a href="/github/guard/guard"><img src="/github/guard/guard.png"></a>
<b>Guard</b>
<span>Guard is a command line tool to easily handle events on file system modifications.</span>
</div>
<div style="clear:both"></div>
</div>
</div>
-->
<div style="clear:both; margin-top: 1rem;">More early adopters:</div>
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://1.gravatar.com/avatar/7710f41976a45c0b25deaf0f2a4577bc?d=https%3A%2F%2Fidenticons.github.com%2Fdceaa0c3804da6d2357baa934f91c119.png&r=x&s=460" width="64">
</div>
<div class="info">
<a href="/github/bbatsov/rubocop"><img src="/github/bbatsov/rubocop.png"></a>
<b>RuboCop</b>
<span>A Ruby static code analyzer.</span>
</div>
<div style="clear:both"></div>
</div>
</div>
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://1.gravatar.com/avatar/d1c216897a0708f79144e2032040f751?d=https%3A%2F%2Fidenticons.github.com%2Ff22cdb30e350832a45debad90dd7f4e1.png&r=x&s=460" width="64">
</div>
<div class="info">
<a href="/github/troessner/reek"><img src="/github/troessner/reek.png"></a>
<b>Reek</b>
<span>Code smell detector for Ruby.</span>
</div>
<div style="clear:both"></div>
</div>
</div>
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://1.gravatar.com/avatar/1f74b13f1e5c6c69cb5d7fbaabb1e2cb?d=https%3A%2F%2Fidenticons.github.com%2F9efb1a59d7b58e69996cf0e32cb71098.png&r=x&s=460" width="64">
</div>
<div class="info">
<a href="/github/sferik/twitter"><img src="/github/sferik/twitter.png"></a>
<b>Twitter</b>
<span>A Ruby interface to the Twitter API.</span>
</div>
<div style="clear:both"></div>
</div>
</div>
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://1.gravatar.com/avatar/5fe204135849ac59602946d565992285?d=https%3A%2F%2Fidenticons.github.com%2F3603599ee31fce12be0faf0958263356.png&r=x&s=460" width="64">
</div>
<div class="info">
<a href="/github/splattael/libnotify"><img src="/github/splattael/libnotify.png"></a>
<b>Libnotify</b>
<span>Ruby bindings for libnotify using FFI.</span>
</div>
<div style="clear:both"></div>
</div>
</div>
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://1.gravatar.com/avatar/f1e3ab214a976a39cfd713bc93deb10f?d=https%3A%2F%2Fidenticons.github.com%2F596676c0468e1aa77be2d247aa42455e.png&r=x&s=460" width="64">
</div>
<div class="info">
<a href="/github/visionmedia/commander"><img src="/github/visionmedia/commander.png"></a>
<b>Commander</b>
<span>The complete solution for Ruby CLIs</span>
</div>
<div style="clear:both"></div>
</div>
</div>
<div class="featured-wrapper" style="float: {% cycle 'left', 'right' %}">
<div class="featured-card">
<div class="picture">
<img src="https://1.gravatar.com/avatar/5c2b452f6eea4a6d84c105ebd971d2a4?d=https%3A%2F%2Fidenticons.github.com%2F2ae3d2aaceaf26246581744124859b07.png&r=x&s=460" width="64">
</div>
<div class="info">
<a href="/github/rkh/mustermann"><img src="/github/rkh/mustermann.png"></a>
<b>Mustermann</b>
<span>Your personal string matching expert</span>
</div>
<div style="clear:both"></div>
</div>
</div>
<div style="clear:both"></div>
<script>
$('body').on('click','.featured-wrapper', function(evt) {
$(this).find('a')[0].click();
})
</script>