Skip to content
This repository was archived by the owner on Sep 20, 2021. It is now read-only.

Commit 0572a67

Browse files
committed
doc(readme) Add logo and badges.
1 parent d6acb02 commit 0572a67

3 files changed

Lines changed: 57 additions & 5 deletions

File tree

resource/logo.svg

Lines changed: 22 additions & 0 deletions
Loading

src/Compiler/Target/Html/Template/Public/css/main.css

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,12 +270,15 @@ a {
270270
}
271271

272272
p {
273-
text-align: justify;
274273
hyphens: auto;
275274
-webkit-hyphens: auto;
276275
-ms-hyphens: auto;
277276
}
278277

278+
p:not([align]) {
279+
text-align: justify;
280+
}
281+
279282
p:not(:last-of-type) {
280283
margin-bottom: .6em;
281284
}
@@ -363,3 +366,11 @@ abbr {
363366
text-decoration: none;
364367
font-style: italic;
365368
}
369+
370+
hr {
371+
height: 0.25rem;
372+
margin: 1rem;
373+
padding: 0;
374+
background-color: #e1e4e8;
375+
border: 0;
376+
}

src/README.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,24 @@
1-
Kitab is the ideal companion for **Documentation-Driven Quality** for
2-
PHP programs.
1+
<p align="center">
2+
<img src="../resource/logo.svg" width="250px" />
3+
</p>
4+
5+
---
6+
7+
<p align="center">
8+
<a href="https://travis-ci.org/hoaproject/Kitab"><img src="https://img.shields.io/travis/hoaproject/Kitab/master.svg" alt="Build status" /></a>
9+
<a href="https://packagist.org/packages/hoa/kitab"><img src="https://img.shields.io/packagist/dt/hoa/kitab.svg" alt="Packagist" /></a>
10+
<a href="https://hoa-project.net/LICENSE"><img src="https://img.shields.io/packagist/l/hoa/kitab.svg" alt="License" /></a>
11+
</p>
12+
13+
<p align="center">
14+
<strong>Kitab</strong> is the ideal companion for
15+
<strong>Documentation-Driven Quality</strong> for PHP programs.
16+
</p>
17+
<p align="center">
18+
Made with ❤️ by <a href="https://hoa-project.net"><img src="https://static.hoa-project.net/Image/Hoa.svg" height="18" alt="Hoa" /></a>
19+
</p>
20+
21+
# Kitab
322

423
The goal of Kitab is twofold, **render** and **test** the
524
documentation:
@@ -13,7 +32,7 @@ documentation:
1332
are run directly to ensure the examples are still up-to-date and
1433
working.
1534

16-
# Static documentation
35+
## Static documentation
1736

1837
Kitab is able to compile the documentation inside your code into
1938
static HTML files. A carefully crafted design is provided to ensure a
@@ -43,7 +62,7 @@ namespace directories, more below. The `--open` option opens the
4362
documentation in your default browser as soon as it is generated
4463
successfully.
4564

46-
# DocTest
65+
## DocTest
4766

4867
Documentation test suites, aka DocTest, are generated based on the
4968
examples present in your documentation. Examples are compiled into

0 commit comments

Comments
 (0)