vbrandl/hoc
1
0
Fork 0
Code Issues 1 Pull Requests Actions Projects Releases Wiki Activity

Update index layout

Browse Source
This commit is contained in:
Valentin Brandl 2019-04-20 12:33:09 +02:00
parent 1ec8a76e9c
commit 439d5c0cb1
No known key found for this signature in database
GPG Key ID: 30D341DD34118D7D
1 changed files with 29 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
static/index.html
View File

@ -9,11 +9,11 @@
<body>
<section>
<h1>Hits-of-Code Badges</h1>
</section>
<header>
<h1>Hits-of-Code Badges</h1>
</header>
<section>
<div>
<article>
<p>
This API offers badges for the Hits-of-Code metric for your repositories. This metric was proposed by
<a href="https://www.yegor256.com/">Yegor Bugayenko</a> as an
@ -21,7 +21,7 @@ This API offers badges for the Hits-of-Code metric for your repositories. This m
</p>
<p>
Instead of counting the number of existing lines in a codebase, the number of modified lines is counted. That way, the
Instead of counting the number of existing lines in a codebase, the number of modified lines is counted. That way, the
metric can only grow and never shrink. While this metric still cannot give any information about the code quality, it
gives an overview about the amount of work put into a codebase.
</p>
@ -30,40 +30,32 @@ gives an overview about the amount of work put into a codebase.
There is a <a href="https://github.com/yegor256/hoc/">command-line tool</a> to calculate the HoC of a repository, but
some people might want a nice badge to put in their README, that's why I implemented this API. Currently the API can be
used for GitHub, GitLab and Bitbucket repositories. Just put the following code in your README:
</p>
<pre>
[![Hits-of-Code](https://hitsofcode.com/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;)](https://hitsofcode.com/&lt;service&gt;/&lt;user&gt;/&lt;repo&gt;)
</pre>
<p>
where <code>&lt;service&gt;</code> is one of <code>github</code>, <code>gitlab</code> or <code>bitbucket</code>. So the
following Markdown
</p>
<pre>
[![Hits-of-Code](https://hitsofcode.com/github/vbrandl/hoc)](https://hitsofcode.com/view/github/vbrandl/hoc)
</pre>
<p>
would render this badge:
</p>
<pre>
<a href="https://hitsofcode.com/view/github/vbrandl/hoc"><img src="https://hitsofcode.com/github/vbrandl/hoc" /></a>
</pre>
</div>
</p>
<h2>Colors</h2>
<div>
<p>
You can generate badges with custom colors via the <code>color</code> query parameter. The following predefined colors
are supported:
</p>
<pre>
<img src="/badge?color=brightgreen" />
<img src="/badge?color=green" />
<img src="/badge?color=yellowgreen" />
@ -78,34 +70,50 @@ are supported:
<img src="/badge?color=critical" />
<img src="/badge?color=informational" />
<img src="/badge?color=inactive" />
</pre>
</p>
<p>
You can also pass HTML color codes:
</p>
<pre>
<img src="/badge?color=ff69b4" /> <img src="/badge?color=9cf" />
</pre>
</div>
</p>
<h2>Source Code</h2>
<div>
<p>
The whole service is licensed under the <a href="https://opensource.org/licenses/MIT">MIT license</a> and the source
code <a href="https://github.com/vbrandl/hoc">can be found on GitHub</a>. Feature proposals or pull requests are
welcome.
</div>
</p>
<h2>Contact</h2>
<div>
<p>
You can reach me via mail: <a href="mailto:mail+hoc@vbrandl.net">mail+hoc@vbrandl.net</a> preferably using
my <a href="https://mirror.oldsql.cc/key.asc">GPG key</a>
(<a href="http://pool.sks-keyservers.net/pks/lookup?op=get&amp;search=0x1FFE431282F4B8CC0A7579167FB009175885FC76">from a
keyserver</a>), or by using any other UID from my key.
</div>
</p>
</article>
<footer>
<nav>
<ul>
<li>
<small>Created by <a href="https://www.vbrandl.net">Valentin Brandl</a>.</small>
</li>
</ul>
</nav>
<nav>
<ul>
<li><small><a href="https://github.com/vbrandl/hoc">GitHub</a></small></li>
<li><small><a href="https://opensource.org/licenses/MIT">MIT License</a></small></li>
</ul>
</nav>
</footer>
</section>
</body>