shit_admin: 2026-08-13 12:41:21
This commit is contained in:
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Steph Ango (@kepano)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -0,0 +1,88 @@
|
||||
---
|
||||
name: obsidian-markdown
|
||||
description: Create and edit Obsidian-specific Markdown syntax, including wikilinks, embeds, block references, callouts, properties, tags, and comments. Use for Obsidian notes when these extensions matter; ordinary Markdown is assumed knowledge.
|
||||
license: MIT
|
||||
metadata:
|
||||
copilot-enabled-agents: claude, codex, opencode
|
||||
copilot-builtin-version: "1"
|
||||
copilot-upstream-revision: "a1dc48e68138490d522c04cbf5822214c6eb1202"
|
||||
---
|
||||
|
||||
# Obsidian Markdown
|
||||
|
||||
Use Obsidian-specific syntax accurately. Do not spend tokens explaining ordinary
|
||||
CommonMark or GFM unless the user asks.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. Preserve existing frontmatter keys and formatting when editing a note.
|
||||
2. Use wikilinks for vault notes and Markdown links for external URLs.
|
||||
3. Use embeds, callouts, properties, tags, comments, and block references only
|
||||
when they improve the requested note.
|
||||
4. Check link targets, YAML validity, and block IDs after editing.
|
||||
5. Read the focused reference file when the task needs more syntax detail.
|
||||
|
||||
## Wikilinks and block references
|
||||
|
||||
~~~markdown
|
||||
[[Note Name]]
|
||||
[[Note Name|Display Text]]
|
||||
[[Note Name#Heading]]
|
||||
[[Note Name#^block-id]]
|
||||
[[#Heading in this note]]
|
||||
|
||||
This paragraph is addressable. ^block-id
|
||||
~~~
|
||||
|
||||
Put a block ID on its own line after a list or quote block.
|
||||
|
||||
## Embeds
|
||||
|
||||
Prefix a wikilink with <code>!</code>:
|
||||
|
||||
~~~markdown
|
||||
![[Note Name]]
|
||||
![[Note Name#Heading]]
|
||||
![[image.png|300]]
|
||||
![[document.pdf#page=3]]
|
||||
~~~
|
||||
|
||||
See [Embeds](references/EMBEDS.md) for media, PDF, and query forms.
|
||||
|
||||
## Callouts
|
||||
|
||||
~~~markdown
|
||||
> [!warning] Custom title
|
||||
> Important content.
|
||||
|
||||
> [!faq]- Collapsed by default
|
||||
> Foldable content.
|
||||
~~~
|
||||
|
||||
See [Callouts](references/CALLOUTS.md) for types, aliases, folding, and nesting.
|
||||
|
||||
## Properties, tags, and comments
|
||||
|
||||
~~~yaml
|
||||
---
|
||||
title: My Note
|
||||
date: 2026-07-21
|
||||
tags:
|
||||
- project
|
||||
aliases:
|
||||
- Alternate Name
|
||||
related: "[[Other Note]]"
|
||||
---
|
||||
~~~
|
||||
|
||||
Quote wikilinks used as YAML values. See
|
||||
[Properties](references/PROPERTIES.md) for supported property types and tag rules.
|
||||
|
||||
Use <code>#nested/tag</code> for inline tags. Hide content from reading view with
|
||||
<code>%%inline comments%%</code> or a matching pair of <code>%%</code> markers on
|
||||
separate lines.
|
||||
|
||||
## Attribution
|
||||
|
||||
Adapted from <code>kepano/obsidian-skills</code> at revision
|
||||
<code>a1dc48e68138490d522c04cbf5822214c6eb1202</code>. See <code>LICENSE</code>.
|
||||
@@ -0,0 +1,33 @@
|
||||
# Callouts reference
|
||||
|
||||
## Folding and nesting
|
||||
|
||||
~~~markdown
|
||||
> [!faq]- Collapsed by default
|
||||
> Hidden until expanded.
|
||||
|
||||
> [!faq]+ Expanded by default
|
||||
> Visible but collapsible.
|
||||
|
||||
> [!question] Outer
|
||||
> > [!note] Inner
|
||||
> > Nested content.
|
||||
~~~
|
||||
|
||||
## Built-in types
|
||||
|
||||
| Type | Aliases |
|
||||
| --- | --- |
|
||||
| note | — |
|
||||
| abstract | summary, tldr |
|
||||
| info | — |
|
||||
| todo | — |
|
||||
| tip | hint, important |
|
||||
| success | check, done |
|
||||
| question | help, faq |
|
||||
| warning | caution, attention |
|
||||
| failure | fail, missing |
|
||||
| danger | error |
|
||||
| bug | — |
|
||||
| example | — |
|
||||
| quote | cite |
|
||||
@@ -0,0 +1,27 @@
|
||||
# Embeds reference
|
||||
|
||||
~~~markdown
|
||||
![[Note Name]]
|
||||
![[Note Name#Heading]]
|
||||
![[Note Name#^block-id]]
|
||||
|
||||
![[image.png]]
|
||||
![[image.png|640x480]]
|
||||
![[image.png|300]]
|
||||
|
||||
![[audio.mp3]]
|
||||
![[video.mp4]]
|
||||
|
||||
![[document.pdf]]
|
||||
![[document.pdf#page=3]]
|
||||
![[document.pdf#height=400]]
|
||||
~~~
|
||||
|
||||
A list embed needs a block ID after the list. An embedded search uses an
|
||||
Obsidian query block:
|
||||
|
||||
~~~~markdown
|
||||
~~~query
|
||||
tag:#project status:done
|
||||
~~~
|
||||
~~~~
|
||||
@@ -0,0 +1,18 @@
|
||||
# Properties reference
|
||||
|
||||
Properties are YAML frontmatter at the very start of a note.
|
||||
|
||||
| Property type | Example |
|
||||
| --- | --- |
|
||||
| Text | <code>title: My title</code> |
|
||||
| Number | <code>rating: 4.5</code> |
|
||||
| Checkbox | <code>completed: true</code> |
|
||||
| Date | <code>date: 2026-07-21</code> |
|
||||
| Date and time | <code>due: 2026-07-21T14:30:00</code> |
|
||||
| List | <code>tags: [one, two]</code> or a YAML list |
|
||||
| Link | <code>related: "[[Other Note]]"</code> |
|
||||
|
||||
Obsidian reserves <code>tags</code>, <code>aliases</code>, and
|
||||
<code>cssclasses</code> for their built-in behaviors. Tags may contain letters,
|
||||
numbers (not as the first character), underscores, hyphens, and forward slashes.
|
||||
Prefer YAML lists when a property naturally has multiple values.
|
||||
Reference in New Issue
Block a user