rf-obsidian-markdown

name	rf-obsidian-markdown
status	export-only
description	Obsidian Flavored Markdown conventions for BITE. Use when generating or editing any .md file in the vault (analysis notes, indexes, idea notes, wiki pages). Ensures all output is Obsidian-native and renders correctly in reading view, graph view, and backlink panels. Adapted from kepano/obsidian-skills (MIT).

Obsidian Markdown — BITE Convention

All .md files generated by BITE skills must follow Obsidian Flavored Markdown. This skill covers only Obsidian-specific extensions; standard Markdown (headings, bold, italic, lists, quotes, code blocks, tables) is assumed knowledge. It governs local/generated Markdown output only; it does not define canonical research data.

Core Rules

1. Internal links — use [[wikilinks]] for anything inside the vault. Reserve [text](url) for external URLs only.
2. No raw HTML — Obsidian renders Markdown; HTML tags break reading view and graph indexing.
3. Frontmatter — every note starts with valid YAML between --- fences.
4. Embeds — use ![[path]] for PDFs, images, and note transclusions.
5. Callouts — use > [!type] syntax for highlighted blocks.
6. Tables — never put aliased wikilinks such as [[full/path|abbr]] in Markdown table cells. The pipe breaks table parsing; use plain display text in the cell and place full wikilinks in surrounding prose or frontmatter.
7. Image captions — escape Obsidian reserved < characters in figure/table captions as \<, for example \<MASK> or \< 0.05.

---

Internal Links (Wikilinks)

[[Note Name]]                          Link to note
[[Note Name|Display Text]]             Custom display text
[[Note Name#Heading]]                  Link to heading
[[Note Name#^block-id]]                Link to block
[[#Heading in same note]]              Same-note heading link

When linking to obsidian-vault/analysis notes from other notes, use the full relative path: [[analysis/Category/Venue_Year/Year_Title|Display Title]]

---

Embeds

![[image.png]]                         Embed image
![[image.png|300]]                     Embed image with width
![[document.pdf]]                      Embed PDF
![[document.pdf#page=3]]               Embed PDF at page
![[Note Name]]                         Transclude entire note
![[Note Name#Heading]]                 Transclude section

BITE convention for PDF embeds in analysis notes:

![[paperPDFs/Category/Venue_Year/Year_Title.pdf]]

BITE convention for image embeds in analysis notes:

![[assets/figures/papers/<task_id>/figures/<figure_file>.jpg]]

---

Callouts

> [!abstract] **Quick Links & TL;DR**
> Summary content here.

> [!note] Title
> Note content.

> [!tip]+ Expanded by default
> Tip content.

> [!warning]- Collapsed by default
> Warning content.

Callout types used in BITE

Type	Usage in RF
abstract / tldr	Quick Links & TL;DR in analysis notes
note	General annotations
tip / hint	Aha! Moment highlights (optional)
warning	Limitations, failure modes
example	Concrete use cases
quote / cite	Direct quotes from papers

---

Properties (Frontmatter)

Every note must start with YAML frontmatter:

---
title: "Paper Title"
venue: CVPR
year: 2025
tags:
  - Category_Name
  - technique-tag
  - status/analyzed
aliases:
  - ShortModel
core_operator: One-line description
primary_logic: |
  Multi-line description of the method flow
pdf_ref: obsidian-vault/paperPDFs/Category/Venue_Year/Year_Title.pdf
created: 2026-04-11T12:00
updated: 2026-04-11T12:00
---

Rules:

• Flat only: all keys are top-level scalars or lists; no nested maps.
• Use | for multi-line text values, quoted strings for values containing colons.
• tags use YAML list syntax, not inline #tag in body (frontmatter tags are indexed by Obsidian).
• Do not write a category field in analysis notes. Use tags for grouping.
• aliases are short English/model aliases only, not full titles and not Chinese.
• Do not write a modalities field in analysis note frontmatter.
• Do not write a frontier field in analysis note frontmatter.
• created / updated use ISO 8601 datetime.

---

Tags

tags:
  - Motion_Generation_Text_Speech_Music_Driven
  - diffusion
  - status/analyzed

• Tags in frontmatter are preferred over inline #tag for searchability.
• Use / for nesting: status/analyzed, status/pending.
• Use _ for multi-word tags: Human_Object_Interaction (not hyphens, to match category names).

---

BITE-Specific Conventions

Analysis notes (obsidian-vault/analysis/)

• Frontmatter: full schema (title, venue, year, tags, aliases, core_operator, primary_logic, pdf_ref, claims)
• Body: semantic sections such as 问题与动机, 整体框架, 核心模块与公式推导, 实验与分析, and 局限性与启发
• Bottom: ![[paperPDFs/...]] PDF embed
• Figures/tables: ![[assets/...]] embeds, without ../../ prefixes. Escape < in figure/table caption text as \<.
• Related papers linked via [[analysis/.../Year_Title|Display]]

Collection indexes (obsidian-vault/index/)

• Frontmatter: minimal (title, updated, type)
• Body: lists of [[wikilinks]] to analysis notes, grouped by venue/year/technique
• Purpose: Obsidian graph view navigation for humans

Index layer (obsidian-vault/index/)

• index.jsonl: structured JSONL index for agent consumption
• Obsidian navigation pages with [[wikilinks]] to analysis notes
• domain/ and dataset/: generated graph pages for taxonomy and dataset nodes
• log.md: append-only, no wikilinks needed
• query_pack.md: query results with [[wikilinks]] to cited papers

Idea notes (obsidian-vault/ideas/)

• Frontmatter: hypothesis, status, source_papers (list of wikilinks)
• Body: free-form with [[wikilinks]] to supporting papers

---

References

• Obsidian Flavored Markdown
• Internal links
• Embed files
• Callouts
• Properties
• Adapted from kepano/obsidian-skills (MIT License)