Skip to content
These are the docs for Clay 3.x. Go to the latest version (5.x)
More ways to use this page

HTML

Markdown covers most needs, but sometimes HTML does the job better. You can write HTML directly in your pages:

<details>
  <summary>Show the full configuration</summary>

  Everything in here is hidden until the reader opens it.
</details>
Show the full configuration

Everything in here is hidden until the reader opens it.

Other useful elements:

HTML Result
<kbd>Ctrl</kbd> + <kbd>K</kbd> Ctrl + K
H<sub>2</sub>O H2O
E = mc<sup>2</sup> E = mc2
<mark>marked</mark> marked

#What Clay removes

Docs are often written by many people, including outside contributors. To keep a page from harming its readers, Clay cleans the HTML of every page with DOMPurify when it builds the site. It removes:

  • <script> elements and event handlers like onclick or onerror,
  • javascript: links,
  • forms and their fields (<form>, <input>, <textarea>, <select>), which could be used for phishing,
  • <style> elements and style attributes, which could lay content over the page.

Everything else, including tables, images, <details> and inline formatting, stays as you wrote it.

<p onclick="steal()">Text</p>   <!-- becomes <p>Text</p> -->
<script>alert(1)</script>       <!-- removed -->

Note

Highlighted code keeps its colors: they are added by Clay itself, after your HTML has been cleaned.