obsidian-markdown

Name: obsidian-markdown
Author: freestylefly

458installs95forks

How to install obsidian-markdown?

freestylefly/canghe-skills/obsidian-markdown

$npx -y skills add freestylefly/canghe-skills --skill obsidian-markdown

Installs into the current project.

Summary

Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax. Use when working with .md files in Obsidian, or when the user mentions wikilinks, callouts, frontmatter, tags, embeds, or Obsidian notes.

Files · 1

View on GitHub

SKILL.md

1	# Obsidian Flavored Markdown Skill
2
3	This skill enables skills-compatible agents to create and edit valid Obsidian Flavored Markdown, including all Obsidian-specific syntax extensions.
4
5	## Overview
6
7	Obsidian uses a combination of Markdown flavors:
8	- [CommonMark](https://commonmark.org/)
9	- [GitHub Flavored Markdown](https://github.github.com/gfm/)
10	- [LaTeX](https://www.latex-project.org/) for math
11	- Obsidian-specific extensions (wikilinks, callouts, embeds, etc.)
12
13	## Basic Formatting
14
15	### Paragraphs and Line Breaks
16
17	```markdown
18	This is a paragraph.
19
20	This is another paragraph (blank line between creates separate paragraphs).
21
22	For a line break within a paragraph, add two spaces at the end
23	or use Shift+Enter.
24	```
25
26	### Headings
27
28	```markdown
29	# Heading 1
30	## Heading 2
31	### Heading 3
32	#### Heading 4
33	##### Heading 5
34	###### Heading 6
35	```
36
37	### Text Formatting
38
39	\| Style \| Syntax \| Example \| Output \|
40	\|-------\|--------\|---------\|--------\|
41	\| Bold \| `text` or `__text__` \| `Bold` \| Bold \|
42	\| Italic \| `text` or `_text_` \| `Italic` \| Italic \|
43	\| Bold + Italic \| `*text` \| `Both` \| Both* \|
44	\| Strikethrough \| `~~text~~` \| `~~Striked~~` \| ~~Striked~~ \|
45	\| Highlight \| `==text==` \| `==Highlighted==` \| ==Highlighted== \|
46	\| Inline code \| `` `code` `` \| `` `code` `` \| `code` \|
47
48	### Escaping Formatting
49
50	Use backslash to escape special characters:
51	```markdown
52	\This won't be italic\
53	\#This won't be a heading
54	1\. This won't be a list item
55	```
56
57	Common characters to escape: `\*`, `\_`, `\#`, `` \` ``, `\\|`, `\~`
58
59	## Internal Links (Wikilinks)
60
61	### Basic Links
62
63	```markdown
64	[[Note Name]]
65	[[Note Name.md]]
66	[[Note Name\|Display Text]]
67	```
68
69	### Link to Headings
70
71	```markdown
72	[[Note Name#Heading]]
73	[[Note Name#Heading\|Custom Text]]
74	[[#Heading in same note]]
75	[[##Search all headings in vault]]
76	```
77
78	### Link to Blocks
79
80	```markdown
81	[[Note Name#^block-id]]
82	[[Note Name#^block-id\|Custom Text]]
83	```
84
85	Define a block ID by adding `^block-id` at the end of a paragraph:
86	```markdown
87	This is a paragraph that can be linked to. ^my-block-id
88	```
89
90	For lists and quotes, add the block ID on a separate line:
91	```markdown
92	> This is a quote
93	> With multiple lines
94
95	^quote-id
96	```
97
98	### Search Links
99
100	```markdown
101	[[##heading]] Search for headings containing "heading"
102	[[^^block]] Search for blocks containing "block"
103	```
104
105	## Markdown-Style Links
106
107	```markdown
108	[Display Text](Note%20Name.md)
109	[Display Text](Note%20Name.md#Heading)
110	[Display Text](https://example.com)
111	[Note](obsidian://open?vault=VaultName&file=Note.md)
112	```
113
114	Note: Spaces must be URL-encoded as `%20` in Markdown links.
115
116	## Embeds
117
118	### Embed Notes
119
120	```markdown
121	![[Note Name]]
122	![[Note Name#Heading]]
123	![[Note Name#^block-id]]
124	```
125
126	### Embed Images
127
128	```markdown
129	![[image.png]]
130	![[image.png\|640x480]] Width x Height
131	![[image.png\|300]] Width only (maintains aspect ratio)
132	```
133
134	### External Images
135
136	```markdown
137	![Alt text](https://example.com/image.png)
138	![Alt text\|300](https://example.com/image.png)
139	```
140
141	### Embed Audio
142
143	```markdown
144	![[audio.mp3]]
145	![[audio.ogg]]
146	```
147
148	### Embed PDF
149
150	```markdown
151	![[document.pdf]]
152	![[document.pdf#page=3]]
153	![[document.pdf#height=400]]
154	```
155
156	### Embed Lists
157
158	```markdown
159	![[Note#^list-id]]
160	```
161
162	Where the list has been defined with a block ID:
163	```markdown
164	- Item 1
165	- Item 2
166	- Item 3
167
168	^list-id
169	```
170
171	### Embed Search Results
172
173	````markdown
174	```query
175	tag:#project status:done
176	```
177	````
178
179	## Callouts
180
181	### Basic Callout
182
183	```markdown
184	> [!note]
185	> This is a note callout.
186
187	> [!info] Custom Title
188	> This callout has a custom title.
189
190	> [!tip] Title Only
191	```
192
193	### Foldable Callouts
194
195	```markdown
196	> [!faq]- Collapsed by default
197	> This content is hidden until expanded.
198
199	> [!faq]+ Expanded by default
200	> This content is visible but can be collapsed.
201	```
202
203	### Nested Callouts
204
205	```markdown
206	> [!question] Outer callout
207	> > [!note] Inner callout
208	> > Nested content
209	```
210
211	### Supported Callout Types
212
213	\| Type \| Aliases \| Description \|
214	\|------\|---------\|-------------\|
215	\| `note` \| - \| Blue, pencil icon \|
216	\| `abstract` \| `summary`, `tldr` \| Teal, clipboard icon \|
217	\| `info` \| - \| Blue, info icon \|
218	\| `todo` \| - \| Blue, checkbox icon \|
219	\| `tip` \| `hint`, `important` \| Cyan, flame icon \|
220	\| `success` \| `check`, `done` \| Green, checkmark icon \|
221	\| `question` \| `help`, `faq` \| Yellow, question mark \|
222	\| `warning` \| `caution`, `attention` \| Orange, warning icon \|
223	\| `failure` \| `fail`, `missing` \| Red, X icon \|
224	\| `danger` \| `error` \| Red, zap icon \|
225	\| `bug` \| - \| Red, bug icon \|
226	\| `example` \| - \| Purple, list icon \|
227	\| `quote` \| `cite` \| Gray, quote icon \|
228
229	### Custom Callouts (CSS)
230
231	```css
232	.callout[data-callout="custom-type"] {
233	--callout-color: 255, 0, 0;
234	--callout-icon: lucide-alert-circle;
235	}
236	```
237
238	## Lists
239
240	###

People who liked this also viewed

6 picks

Type

obsidian-markdown

458installs95forks

View on GitHub

How to install obsidian-markdown?

freestylefly/canghe-skills/obsidian-markdown

$npx -y skills add freestylefly/canghe-skills --skill obsidian-markdown

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# Obsidian Flavored Markdown Skill
2
3	This skill enables skills-compatible agents to create and edit valid Obsidian Flavored Markdown, including all Obsidian-specific syntax extensions.
4
5	## Overview
6
7	Obsidian uses a combination of Markdown flavors:
8	- [CommonMark](https://commonmark.org/)
9	- [GitHub Flavored Markdown](https://github.github.com/gfm/)
10	- [LaTeX](https://www.latex-project.org/) for math
11	- Obsidian-specific extensions (wikilinks, callouts, embeds, etc.)
12
13	## Basic Formatting
14
15	### Paragraphs and Line Breaks
16
17	```markdown
18	This is a paragraph.
19
20	This is another paragraph (blank line between creates separate paragraphs).
21
22	For a line break within a paragraph, add two spaces at the end
23	or use Shift+Enter.
24	```
25
26	### Headings
27
28	```markdown
29	# Heading 1
30	## Heading 2
31	### Heading 3
32	#### Heading 4
33	##### Heading 5
34	###### Heading 6
35	```
36
37	### Text Formatting
38
39	\| Style \| Syntax \| Example \| Output \|
40	\|-------\|--------\|---------\|--------\|
41	\| Bold \| `text` or `__text__` \| `Bold` \| Bold \|
42	\| Italic \| `text` or `_text_` \| `Italic` \| Italic \|
43	\| Bold + Italic \| `*text` \| `Both` \| Both* \|
44	\| Strikethrough \| `~~text~~` \| `~~Striked~~` \| ~~Striked~~ \|
45	\| Highlight \| `==text==` \| `==Highlighted==` \| ==Highlighted== \|
46	\| Inline code \| `` `code` `` \| `` `code` `` \| `code` \|
47
48	### Escaping Formatting
49
50	Use backslash to escape special characters:
51	```markdown
52	\This won't be italic\
53	\#This won't be a heading
54	1\. This won't be a list item
55	```
56
57	Common characters to escape: `\*`, `\_`, `\#`, `` \` ``, `\\|`, `\~`
58
59	## Internal Links (Wikilinks)
60
61	### Basic Links
62
63	```markdown
64	[[Note Name]]
65	[[Note Name.md]]
66	[[Note Name\|Display Text]]
67	```
68
69	### Link to Headings
70
71	```markdown
72	[[Note Name#Heading]]
73	[[Note Name#Heading\|Custom Text]]
74	[[#Heading in same note]]
75	[[##Search all headings in vault]]
76	```
77
78	### Link to Blocks
79
80	```markdown
81	[[Note Name#^block-id]]
82	[[Note Name#^block-id\|Custom Text]]
83	```
84
85	Define a block ID by adding `^block-id` at the end of a paragraph:
86	```markdown
87	This is a paragraph that can be linked to. ^my-block-id
88	```
89
90	For lists and quotes, add the block ID on a separate line:
91	```markdown
92	> This is a quote
93	> With multiple lines
94
95	^quote-id
96	```
97
98	### Search Links
99
100	```markdown
101	[[##heading]] Search for headings containing "heading"
102	[[^^block]] Search for blocks containing "block"
103	```
104
105	## Markdown-Style Links
106
107	```markdown
108	[Display Text](Note%20Name.md)
109	[Display Text](Note%20Name.md#Heading)
110	[Display Text](https://example.com)
111	[Note](obsidian://open?vault=VaultName&file=Note.md)
112	```
113
114	Note: Spaces must be URL-encoded as `%20` in Markdown links.
115
116	## Embeds
117
118	### Embed Notes
119
120	```markdown
121	![[Note Name]]
122	![[Note Name#Heading]]
123	![[Note Name#^block-id]]
124	```
125
126	### Embed Images
127
128	```markdown
129	![[image.png]]
130	![[image.png\|640x480]] Width x Height
131	![[image.png\|300]] Width only (maintains aspect ratio)
132	```
133
134	### External Images
135
136	```markdown
137	![Alt text](https://example.com/image.png)
138	![Alt text\|300](https://example.com/image.png)
139	```
140
141	### Embed Audio
142
143	```markdown
144	![[audio.mp3]]
145	![[audio.ogg]]
146	```
147
148	### Embed PDF
149
150	```markdown
151	![[document.pdf]]
152	![[document.pdf#page=3]]
153	![[document.pdf#height=400]]
154	```
155
156	### Embed Lists
157
158	```markdown
159	![[Note#^list-id]]
160	```
161
162	Where the list has been defined with a block ID:
163	```markdown
164	- Item 1
165	- Item 2
166	- Item 3
167
168	^list-id
169	```
170
171	### Embed Search Results
172
173	````markdown
174	```query
175	tag:#project status:done
176	```
177	````
178
179	## Callouts
180
181	### Basic Callout
182
183	```markdown
184	> [!note]
185	> This is a note callout.
186
187	> [!info] Custom Title
188	> This callout has a custom title.
189
190	> [!tip] Title Only
191	```
192
193	### Foldable Callouts
194
195	```markdown
196	> [!faq]- Collapsed by default
197	> This content is hidden until expanded.
198
199	> [!faq]+ Expanded by default
200	> This content is visible but can be collapsed.
201	```
202
203	### Nested Callouts
204
205	```markdown
206	> [!question] Outer callout
207	> > [!note] Inner callout
208	> > Nested content
209	```
210
211	### Supported Callout Types
212
213	\| Type \| Aliases \| Description \|
214	\|------\|---------\|-------------\|
215	\| `note` \| - \| Blue, pencil icon \|
216	\| `abstract` \| `summary`, `tldr` \| Teal, clipboard icon \|
217	\| `info` \| - \| Blue, info icon \|
218	\| `todo` \| - \| Blue, checkbox icon \|
219	\| `tip` \| `hint`, `important` \| Cyan, flame icon \|
220	\| `success` \| `check`, `done` \| Green, checkmark icon \|
221	\| `question` \| `help`, `faq` \| Yellow, question mark \|
222	\| `warning` \| `caution`, `attention` \| Orange, warning icon \|
223	\| `failure` \| `fail`, `missing` \| Red, X icon \|
224	\| `danger` \| `error` \| Red, zap icon \|
225	\| `bug` \| - \| Red, bug icon \|
226	\| `example` \| - \| Purple, list icon \|
227	\| `quote` \| `cite` \| Gray, quote icon \|
228
229	### Custom Callouts (CSS)
230
231	```css
232	.callout[data-callout="custom-type"] {
233	--callout-color: 255, 0, 0;
234	--callout-icon: lucide-alert-circle;
235	}
236	```
237
238	## Lists
239
240	###

People who liked this also viewed

6 picks

Type