Qbead Logo

Literate Layout

This page uses layout: literate. This layout is specifically designed for literate programming documentation. It is intended to be used by markdown content that is auto-generated from the codedocs build process.

See the main README for details.

---
layout: literate
---

When to Use

Usually auto-generated - This layout is primarily used for literate programming documentation generated by the Makefile from external repositories.

How it works

Normal text needs to be inside of <div> blocks with a literate-text class. Code blocks will need to have extra metadata stating class=codeblock.

See the code example for how this portion of the page was rendered.

<div class="literate-text">

## How it works

Normal text needs to be inside of `<div>` blocks with a `literate-text` class.
Code blocks will need to have extra metadata stating `class=codeblock`.

See the code example for how this portion of the page was rendered.

</div>

```md class=codeblock
Things get recursive here....
```