Zum Inhalt springen
Das ist die Dokumentation für Clay 3.x. Zur neuesten Version (5.x)
Weitere Möglichkeiten mit dieser Seite

HTML

Markdown deckt das meiste ab, aber manchmal erledigt HTML eine Aufgabe besser. Du kannst HTML direkt in deine Seiten schreiben:

<details>
  <summary>Die ganze Konfiguration zeigen</summary>

  Alles hier drin bleibt verborgen, bis der Leser es aufklappt.
</details>
Die ganze Konfiguration zeigen

Alles hier drin bleibt verborgen, bis der Leser es aufklappt.

Weitere nützliche Elemente:

HTML Ergebnis
<kbd>Strg</kbd> + <kbd>K</kbd> Strg + K
H<sub>2</sub>O H2O
E = mc<sup>2</sup> E = mc2
<mark>markiert</mark> markiert

#Was Clay entfernt

Dokumentation schreiben oft viele Menschen, auch von außerhalb des Projekts. Damit eine Seite ihren Lesern nicht schaden kann, bereinigt Clay beim Bauen das HTML jeder Seite mit DOMPurify. Entfernt werden:

  • <script>-Elemente und Event-Handler wie onclick oder onerror,
  • javascript:-Links,
  • Formulare und ihre Felder (<form>, <input>, <textarea>, <select>), die sich für Phishing nutzen ließen,
  • <style>-Elemente und style-Attribute, mit denen sich Inhalte über die Seite legen ließen.

Alles andere, auch Tabellen, Bilder, <details> und Formatierungen im Text, bleibt so, wie du es geschrieben hast.

<p onclick="steal()">Text</p>   <!-- wird zu <p>Text</p> -->
<script>alert(1)</script>       <!-- wird entfernt -->

Hinweis

Hervorgehobener Code behält seine Farben: Clay fügt sie selbst hinzu, nachdem dein HTML bereinigt wurde.