This section provides examples of all style elements available to documentation authors and the guidelines on using them.
Links
We have special types of links to refer readers to:
Input:
import {Term, Schema} from '/components/common.jsx'
Raw data is stored in <Term t="slices" id="data-slice"/> that
are linked from <Schema t="MetadataBlock"/>s.
Result:
Raw data is stored in that are linked from s.
Code Blocks
Input:
```js
const client = OdfClient::new("odf+https://localhost:8080");
```
Result:
const client = OdfClient::new("odf+https://localhost:8080");
Text Blocks
Input:
<Tip>
Tip block
</Tip>
<Note>
Note block
</Note>
<Info>
Info block
</Info>
<Warning>
Warning block
</Warning>
<Danger>
Danger block
</Danger>
Result:
Tables
Input:
| Name | Description |
| ---- | :---------: |
| Foo | Test |
| Bar | Test |
Result:
| Name | Description |
|---|
| Foo | Test |
| Bar | Test |
Tabs
Input:
<Tabs>
<Tab title="First tab">
Tab 1 content with plain text
</Tab>
<Tab title="Second tab">
Tab 2 with markdown
- as
- list
</Tab>
<Tab title="Third tab">
<Info>Tab 3 content with rich elements</Info>
</Tab>
</Tabs>
Result:
First tab
Second tab
Third tab
Tab 1 content with plain text
Tab 3 content with rich elements
Static Image
Input:
<img
src="/images/kamu-logo-dark.svg"
alt="Kamu logo"
style={{width: "30%"}}
className="rounded-lg"
/>
Result:
YouTube Video
Input:
import {YouTube} from '/components/common.jsx'
<YouTube id="hN_vpHYmwi0"/>
Result:
YouTube Playlist
Input:
import {YouTubeList} from '/components/common.jsx'
<YouTubeList id="PLV91cS45lwVG20Hicztbv7hsjN6x69MJk"/>
Result:
Mermaid Diagrams
Input:
```mermaid
sequenceDiagram
Alice ->> Bob: Hello Bob, how are you?
Bob-->>John: How about you John?
Bob--x Alice: I am good thanks!
Bob-x John: I am good thanks!
Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.
Bob-->Alice: Checking with John...
Alice->John: Yes... John, how are you?
```
Result:
See more examples here. Last modified on March 16, 2026