orcanote-markdown

Files (1)

• SKILL.md

SKILL.md (first lines)

# Orca Note Flavored Markdown Skill

This skill enables skills-compatible agents to create and edit valid Orca Note Flavored Markdown, including all Orca Note-specific syntax extensions.

## Overview

Orca Note uses a combination of Markdown flavors:
- [CommonMark](https://commonmark.org/)
- [GitHub Flavored Markdown](https://github.github.com/gfm/)
- [LaTeX](https://www.latex-project.org/) for math
- Orca Note-specific extensions (auto headings, highlights, callouts, etc.)

## Basic Formatting

### Paragraphs and Line Breaks

```markdown
This is a paragraph.

This is another paragraph (blank line between creates separate paragraphs).
```

### Headings

```markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
```

Maximum heading level is 4 (`####`).

### Text Formatting

| Style | Syntax | Example | Output |
|-------|--------|---------|--------|
| Bold | `**text**` or `__text__` | `**Bold**` | **Bold** |
| Italic | `*text*` or `_text_` | `*Italic*` | *Italic* |
| Bold + Italic | `***text***` | `***Both***` | ***Both*** |
| Strikethrough | `~~text~~` | `~~Striked~~` | ~~Striked~~ |
| Highlight | `==text==` | `==Highlighted==` | ==Highlighted== |
| Inline code | `` `code` `` | `` `code` `` | `code` |

### Escaping Formatting

Use backslash to escape special characters:
```markdown
\*This won't be italic\*
\#This won't be a heading
1\. This won't be a list item
```

Common characters to escape: `\*`, `\_`, `\#`, `` \` ``, `\|`, `\~`

## Link to Blocks

```markdown
[[BlockID]]
[[Block Alias]]
```

Block ID is a number.

## Markdown-Style Links

```markdown
[Display Text](https://example.com)
[Link used outside of Orca Note](orca-note://[repo]/block?blockId=[blockId])
```

Note: Spaces must be URL-encoded as `%20` in Markdown links.

## Images, Videos & Audios

```markdown
![video](https://example.com/video)
![audio](https://example.com/audio)
![Image alt text](https://example.com/image.png)
```

## Video/Audio Timestamps

```markdown
{01:59:59}
{59:59}
```

## Callouts

### Basic Callout

```markdown
> [!note]
> This is a notice callout.
```

### Nested Callouts

```markdown
> [!info]
> Outer callout
> > [!note]
> > Inner callout
```

### Supported Callout Types

| Type | Description |
|------|-------------|
| `info` | Blue, info icon |
| `warning` | Orange, warning icon |
| `error` | Red, exclamation icon |
| `tip` | Green, bulb icon |
| `important` | Purple, exclamation icon |
| `note` | Grey, note icon |

## Lists

From sethyuan/orcanote-agent-skills, MIT.

More from sethyuan/orcanote-agent-skills