Skip to content

Commit cccf717

Browse files
authored
docs(readme): fit the badges on one row and drop a rule from the header (#1567)
Two small fixes to the header that #1566 introduced. **The badge row wrapped.** Six badges in the `for-the-badge` style are wider than a typical readme column, so the last one stranded on a second line, which reads as an accident rather than a layout. The **licence badge** is removed: GitHub already shows the licence as a tab directly above the readme, so it was the one badge carrying nothing the reader did not already have. Five remain and fit. **The tagline had a rule under it.** GitHub draws one under `h1` and `h2`, which put a line between the tagline and the guide links for no reason. It becomes an `h3` element, which keeps the size without the rule; `markdownlint`'s allow-list gains `h3`. docs: N/A — the readme is the change; no documentation page describes it.
1 parent c78936b commit cccf717

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

.markdownlint.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"code",
1111
"details",
1212
"div",
13+
"h3",
1314
"img",
1415
"p",
1516
"picture",

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# decky-romm-sync
66

7-
## Your self-hosted RomM library, in your Steam library
7+
<h3>Your self-hosted RomM library, in your Steam library</h3>
88

99
[Getting Started](https://danielcopper.github.io/decky-romm-sync/user-guide/getting-started/) ·
1010
[Configuration](https://danielcopper.github.io/decky-romm-sync/user-guide/configuration/) ·
@@ -20,7 +20,6 @@
2020
<a href="https://github.com/danielcopper/decky-romm-sync/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/danielcopper/decky-romm-sync?style=for-the-badge&color=4795c9&labelColor=16202c"></a>
2121
<a href="https://github.com/danielcopper/decky-romm-sync/releases"><img alt="Downloads" src="https://img.shields.io/github/downloads/danielcopper/decky-romm-sync/total?style=for-the-badge&color=4795c9&labelColor=16202c"></a>
2222
<a href="https://github.com/rommapp/romm/releases"><img alt="Requires RomM 4.9.0 or newer" src="https://img.shields.io/badge/RomM-%E2%89%A5%204.9.0-4795c9?style=for-the-badge&labelColor=16202c"></a>
23-
<a href="https://github.com/danielcopper/decky-romm-sync/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-GPL--3.0-4795c9?style=for-the-badge&labelColor=16202c"></a>
2423

2524
</div>
2625

0 commit comments

Comments
 (0)