Skip to content
girok-md

Markdown Syntax

girok-md supports standard markdown plus Obsidian-specific features like Wikilinks, Callouts, and image embeds.

Link to other posts using Wikilinks.

[[Document Name]]
[[Document Name|Display Text]]

Image Embeds

Embed images using the Obsidian-style syntax.

![[image.png]]
![[image.png|300]]

Images are automatically synced from your source folder to public/assets/.

Callouts

Create styled callout boxes for notes, warnings, and tips.

Syntax

> [!NOTE] Title
> Your callout content here.
> Can span multiple lines.

Available Types

> [!NOTE]
> Highlights information that users should take into account.

Folding Callouts

Make callouts collapsible:

> [!FAQ]- Frequently Asked Questions
> This content is hidden by default.
> Click to expand.

Code Blocks

Standard fenced code blocks with syntax highlighting:

```typescript
function greet(name: string): string {
  return `Hello, ${name}!`;
}
```

Supported Languages

girok-md uses Astro’s built-in Shiki highlighter, supporting 100+ languages including:

  • JavaScript/TypeScript
  • Python, Ruby, Go, Rust
  • HTML, CSS, SCSS
  • JSON, YAML, TOML
  • Bash, PowerShell
  • And many more…

Tables

Standard markdown tables:

| Feature | Supported |
|---------|-----------|
| Wikilinks | ✅ |
| Callouts | ✅ |
| Image embeds | ✅ |

GFM Features

girok-md supports GitHub Flavored Markdown (GFM):

Task Lists

- [x] Completed task
- [ ] Incomplete task

Strikethrough

~~deleted text~~

URLs are automatically converted to links:

https://github.com/7loro/girok-md

Math (LaTeX)

Inline and block math expressions using LaTeX:

Inline: $E = mc^2$


Block:
$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$