orcanote-markdown

SKILL.md

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:

Basic Formatting

Paragraphs and Line Breaks

This is a paragraph.

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

Headings

# 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:

\*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

[[BlockID]]

Block ID is a number.

Markdown-Style Links

[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

![Alt text](https://example.com/image.png)
![Alt text](https://example.com/video.mp4)
![Alt text](https://example.com/audio.mp3)

Callouts

Basic Callout

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

Nested Callouts

> [!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

Unordered Lists

- Item 1
- Item 2
  - Nested item
  - Another nested
- Item 3

Ordered Lists

1. First item
2. Second item
   1. Nested numbered
   2. Another nested
3. Third item

Task Lists

- [ ] Incomplete task
- [x] Completed task
- [ ] Task with sub-tasks
  - [ ] Subtask 1
  - [x] Subtask 2

Quotes

> This is a blockquote.
> It can span multiple lines.
>
> And include multiple paragraphs.
>
> > Nested quotes work too.

Code

Inline Code

Use `backticks` for inline code.
Use double backticks for ``code with a ` backtick inside``.

Code Blocks

```
Plain code block
```

```javascript
// Syntax highlighted code block
function hello() {
  console.log("Hello, world!");
}
```

```python
# Python example
def greet(name):
    print(f"Hello, {name}!")
```

Tables

| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Math (LaTeX)

Inline Math

This is inline math: $e^{i\pi} + 1 = 0$

Block Math

$$
\begin{vmatrix}
a & b \\
c & d
\end{vmatrix} = ad - bc
$$

Common Math Syntax

$x^2$              Superscript
$x_i$              Subscript
$\frac{a}{b}$      Fraction
$\sqrt{x}$         Square root
$\sum_{i=1}^{n}$   Summation
$\int_a^b$         Integral
$\alpha, \beta$    Greek letters

Diagrams (Mermaid)

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Do this]
    B -->|No| D[Do that]
    C --> E[End]
    D --> E
```

Whiteboard (Excalidraw)

```whiteboard
{
  "elements": [...],
  "files": {}
}
```

Horizontal Rules

---
***
___
- - -
* * *

Complete Example

# Project Alpha

## Overview

This project aims to improve workflow using modern techniques.

> [!important]
> The first milestone is due on ==January 30th==.

## Tasks

- [x] Initial planning
- [x] Resource allocation
- [ ] Development phase
  - [ ] Backend implementation
  - [ ] Frontend design
- [ ] Testing
- [ ] Deployment

## Technical Notes

The main algorithm uses the formula $O(n \log n)$ for sorting.

```python
def process_data(items):
    return sorted(items, key=lambda x: x.priority)
```

## Architecture

```mermaid
graph LR
    A[Input] --> B[Process]
    B --> C[Output]
    B --> D[Cache]
```

References

  • See orcanote-mermaid skill for Mermaid syntax and more details.
  • See orcanote-whiteboard skill for whiteboard syntax (based on Excalidraw) and more details.
Weekly Installs
3
GitHub Stars
2
First Seen
14 days ago
Installed on
github-copilot3
codex3
kimi-cli3
gemini-cli3
cursor3
amp3