Skip to content

Instantly share code, notes, and snippets.

@tinycrops
Last active April 7, 2026 04:37
Show Gist options
  • Select an option

  • Save tinycrops/2fb0b9bb63ba18bd960585b5d0d8a613 to your computer and use it in GitHub Desktop.

Select an option

Save tinycrops/2fb0b9bb63ba18bd960585b5d0d8a613 to your computer and use it in GitHub Desktop.
ObsidianMD.showcase
aliases
OFM Showcase
tags
obsidian
markdown
showcase
cssclasses
obsidian-showcase
status complete
created 2026-04-06
related
[[Showcase Companion]]

Obsidian Markdown Showcase

This note is a compact tour of Obsidian Flavored Markdown using current official syntax. It demonstrates plain Markdown, Obsidian-only extensions, and a few adjacent features that ride on top of Markdown files and properties.

Quick tour

  • Internal wikilink: [[Showcase Companion]]
  • Wikilink with alias: [[Showcase Companion|companion note]]
  • Markdown link to a local note: Companion
  • External link: Obsidian Help
  • Heading link: [[Showcase Companion#Section Link Target]]
  • Block link: [[Showcase Companion#^callout-block]]
  • Tag in body text: #obsidian #knowledge-management

Basic formatting

This paragraph shows bold, italic, bold italic, ==highlight==, strikethrough, and inline code.

You can also escape formatting when needed: *literal asterisks*, #literal-hash, and 1. not-a-list-item.

Lists

  • Bullet one
  • Bullet two
    • Nested bullets also work
    • So do mixed styles
  1. Ordered item
  2. Another ordered item
  3. Final ordered item

Tasks

  • Create the note
  • Add embeds
  • Customize with your own examples

Quotes and callouts

A normal blockquote still works exactly like standard Markdown.

[!note] Standard callout Callouts are one of Obsidian's signature Markdown extensions.

[!tip] Custom title Callouts can contain formatting, lists, links to [[Showcase Companion]], and even embeds.

[!warning]- Folded by default This callout starts collapsed.

[!example]+ Expanded by default This one starts open and can hold multi-line content.

  • Embedded note section: ![[Showcase Companion#Section Link Target]]

Tables

Feature Syntax family Example
Internal links Obsidian [[Note Name]]
Embeds Obsidian ![[Note Name]]
Footnotes Markdown [^1]
Math MathJax $e^{i\pi} + 1 = 0$
Diagrams Mermaid mermaid

Code blocks

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

console.log(greet("Obsidian"));
![[Showcase Companion#^workflow-block]]
%% This is a comment. It appears in source, but not in reading view. %%

Embeds and transclusion

Full note embed

![[Showcase Companion]]

Section embed

![[Showcase Companion#Section Link Target]]

Block embed

![[Showcase Companion#^workflow-block]]

Image embed

![[Attachments/obsidian-showcase.svg]]

Mermaid diagrams

flowchart LR
    Idea["Capture idea"] --> Note["Write Markdown note"]
    Note --> Link["Add [[links]]"]
    Link --> Graph["See connections grow"]
Loading
sequenceDiagram
    participant U as User
    participant O as Obsidian
    U->>O: Create note
    U->>O: Add links and properties
    O-->>U: Local, searchable knowledge
Loading

Math

Inline math works here: $e^{i\pi} + 1 = 0$.

$$ \int_0^1 x^2,dx = \frac{1}{3} $$

Footnotes

Obsidian supports footnotes in standard Markdown style.1

Source-view-only tricks

Comments are hidden in reading view, so the next line is mostly useful in source mode:

%% This sentence exists in the file, but rendered reading view hides it. %%

Markdown inside raw HTML does not render, which is useful to remember when mixing formats:

<div>This **will not** render as bold inside the HTML block.</div>

Properties and Bases-friendly structure

This note has YAML properties at the top. Obsidian uses those for metadata, filtering, search, and newer database-style workflows such as Bases.

---
status: complete
tags:
  - obsidian
  - markdown
related:
  - "[[Showcase Companion]]"
---

Official docs used for this showcase

Footnotes

  1. Footnotes are great for side comments, citations, and asides without interrupting the flow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment