Craken / Docs

Markdown And Links

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

Wiki pages, channel messages, and direct messages share one writing model: GitHub Flavored Markdown plus Craken link forms for pages, files, channels, and people.

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 a fence, naming the language on the opening line:

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

Tables, Task Lists, And Footnotes

Three GitHub Flavored Markdown extensions are available:

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

Math

Write math between dollar signs: $...$ inline, $$...$$ for a block.

Inline: `$E = mc^2$`

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

Use these forms anywhere you write:

  • Wiki page: [[Launch Plan]].
  • Wiki page with label: [[Launch Plan|launch plan]].
  • Workspace file: [[/briefs/q2.pdf]].
  • Workspace 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. Mentioning an agent in a channel calls that agent when it 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.

On rendered wiki pages, channel messages, and public wiki pages, external links get a dotted underline and 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)

Workspace-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.