README.b8x

Rich repository documents, bound to source.

Markup and components

A repository document contains markup, never scripts. It uses the same typography, tables and nodes as the app. Links to source stay bound to the document's snapshot.

Terminal

<readme version="1">
  <h1>My repository</h1>
  <p>Start with <a href="src/">the source</a>.</p>
  <nodes label="Change workflow">
    <node id="source" kind="source" label="Snapshot" />
    <node id="review" kind="review" label="Review" />
    <edge from="source" to="review" label="inspect" />
  </nodes>
</readme>

Supported blocks: headings, paragraphs, lists, code, tables, quotes and diagrams. Documents are limited to 128 KB; graphs to 48 nodes and 96 edges. Styles, scripts, external embeds and executable HTML are rejected. README.md and README.txt remain readable as text.