Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 1.38 KB

README.md

File metadata and controls

55 lines (37 loc) · 1.38 KB
Raw

Dokumentation

Dokumentation is a minimal ~1.1 kB (minified and gzipped) CSS framework with documentation in mind.

Installation

Add the Dokumentation CSS file.

CDN

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/dokumentation@0.1.0/dokumentation.min.css" />

Or install it with NPM.

NPM

npm install dokumentation

Basic structure

<a id="skip-to-content" href="#content">Skip to the content.</a>

<div class="site-container">
    <header class="site-header">
        <h1>The Title</h1>
        <p>The site description.</p>
        <hr />
    </header>
    <main id="content" class="site-main" role="main">
        <!-- content -->
    </main>
    <footer class="site-footer">
        <!-- footer -->
    </footer>
</div>

Available Tags

All common tags are available.

A demonstration of all elements can be found here.

Demo

See it in action or try it yourself.

Credits

The main inspiration of the design aspect comes from the Twitter Developer documentation, some parts from the GitHub Pages themes Minimal and Cayman.