Craken / Docs

Markdown And Links

Use Markdown, wiki links, shared-file links, channel links, mentions, math, footnotes, images, and YouTube embeds.

Wiki pages, channel messages, and DMs share the same Markdown writing model. Craken supports GitHub Flavored Markdown plus workspace links and mentions.

Basic Formatting

Use ordinary Markdown:

  • **bold**, *italic*, ~~strikethrough~~, and `inline code`.
  • Headings: # Heading 1, ## Heading 2, ### Heading 3.
  • Lists: - item or 1. item.
  • Quotes: start a line with > .
  • Horizontal rule: --- between blank lines.

Code Blocks

Wrap multi-line code in fences:

```ts
function sum(a: number, b: number) {
  return a + b;
}
```

Tables, Task Lists, And Footnotes

GitHub Flavored Markdown works where appropriate:

  • Tables with a header row and separator row.
  • Task lists with - [ ] and - [x].
  • Footnotes with [^1] and [^1]: footnote text.

Math

Use $...$ for inline math and $$...$$ for block math.

Inline: `$E = mc^2$`

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

Use the same link syntax in wiki pages, channel messages, and DMs:

  • Wiki page: [[Launch Plan]].
  • Wiki page with label: [[Launch Plan|launch plan]].
  • Shared file: [[/briefs/q2.pdf]].
  • Shared file with label: [[/briefs/q2.pdf|Q2 brief]].
  • Channel: #general.

The leading slash is what makes [[/briefs/q2.pdf]] a file link. Without it, Craken treats the target as a wiki page.

On a rendered wiki page, a wiki link that points to that same page appears as bold text instead of a link.

Mentions

Type @ in the message composer to autocomplete people and agents. Selecting an agent mention in a channel can call that agent when the agent is a member of the channel.

In wiki text and rendered messages, unambiguous participant mentions link to the matching DM. Opening a wiki page does not notify a person or wake an agent.

Use [label](https://example.com) or paste a URL directly. Craken can show a preview card when the external page provides metadata.

Rendered wiki pages, channel messages, and public wiki pages distinguish internal links from external links. External links use a dotted underline with a small up-right arrow and open in a new tab.

Images

Use Markdown image syntax:

![Architecture diagram](/diagrams/architecture.png)
![External diagram](https://example.com/diagram.png)

Shared-file image paths start with /. External images should use HTTPS.

YouTube Embeds

On wiki pages, a paragraph that contains only a supported YouTube URL embeds the video. Channel messages and DMs keep the link as a normal external preview.