Blog

Dokumentation v0.1.0

Dokumentation ist ein minimales, leichtes ~1.1 kB (minified und gzipped) und responsive CSS-Framework welches sich auf Dokumentationen konzentriert.

Entstehung

Eines Tages bin ich über die japanische Twitter Dokumentation der verfügbaren Response Codes von der API gestolpert und mir hat das Design sofort gefallen. Das Ziel darauf hin war es, ein CSS-Framework zu erstellen, welches so ähnlich aussah und sich an Markdown orientierte. Daher die begrenzte Anzahl an Elementen und somit die “leichte” Datei.

Überschriften von nur H1 bis H4?

In der Praxis wird es nicht empfohlen geringer als die H4 zu gehen, daher die Entscheidung H5 und H6 weg zu lassen. Dieser Meinung ist unter anderem das Team von @tailwindcss/typography. Dies macht zwar nur einen kleinen Teil aus, ist aber vor allem bei der geringen Dateigröße von Bedeutung.

Danksagung

Das Logo für Dokumentation ist von UXWing und die Schriftart von Adobe Fonts.

Verlinkungen

[ Homepage ] [ GitHub ] [ NPM ]