okay

Projekt

Diese Website hier ist statisch und wird mit einem eigenen Tool generiert. Es hat den schönen Namen okay

Werkzeuge

PyYAML

xml.dom.minidom aus der Python Standard Library

Features

✔︎

• generiert Webseiten
• generiert einen Atom Feed
• generiert eine Seite mit Tags

✘︎

• ☃︎

Umsetzung

Die Webseite wird direkt aus YAML Files gebaut.

Damit bin so nah dran am HTML wie nötig, dabei aber so weit weg wie möglich.

Der Parser hält sich an folgende Konzepte:

• Die Grundstruktur ist eine Liste.
  neues Listenelement == neue Zeile im HTML.
• Strings werden formatiert, bevor sie weitergereicht werden.
  Damit ist es möglich Variablen einzuschleusen:
  z.B. steht im Quelltext ein '{brace.encoding}' so wird daraus 'utf-8'
• Dictionaries beschreiben HTML Elemente.
  Der Key mit einer Liste als Value beschreibt den Namen und die darunter liegenden HTML Elemente.
  Führende underscores '_' werden aus den Keys gestrichen, um z.B. Konflikte mit 'class' und 'id' zu verhindern.
  Alle weiteren Key-Value Pairs sind Attribute des HTML Elements.
• Weitere Elemente (z.B. 'True', 'False', 'None') werden verworfen.
• Der Header enthält Basis-Informationen wie Beschreibung, Titel, Datum, Tags, ... der Seite.

Die Notation sieht so aus:

- _div:
  - Meine awesome
  - _a:
    - Webseite
    href: '{url.base}'
  class: example

Das Ergebnis:

<div class="example">
  Meine awesome
  <a href="https://www.der-beweis.de">Webseite</a>
</div>

Was soll der Name?!?

Die Welt ist voll mit Statischen Website-Generatoren.

Leider machen diese nur den Autor dessen glücklich, sonst niemanden.

Nach einer sehr sehr langen Odysee habe ich beschlossen meinen eigenen Generator zu schreiben.

Dieser hat den Namen okay damit er nicht versehentlich öffentlich oder sogar erfolgreich wird... :)