Obsidian Writer

Obsidian Writer

Write .md and .canvas files that render correctly in Obsidian. 输出 to the vault directory, 同步ed via Git.

Vault Location

Default: ~/obsidian-vault/ (configurable per 请求).

工作流 Write .md / .canvas files following specs below Git commit + push (代理 does this automatically) User's Mac Mini pulls → 同步s to iCloud → Obsidian reads Markdown — Obsidian-Specific Syntax

Standard Markdown (headings, bold, 列出s, code blocks) is assumed known. Only Obsidian 扩展s below:

Properties (Frontmatter)

Must be the very first thing in the file:

---

tags: - finance/macro - iran-war aliases: - 伊朗战争概览 cssclasses: - wide-page 创建d: 2026-03-10

---

Reserved keys: tags, aliases, cssclasses, publish, permalink, description.

Internal Links (Wikilinks) [[Note Name]] # link to note [[Note Name|Display Text]] # custom display [[Note Name#Heading]] # link to heading [[Note Name#^block-id]] # link to block

Block References

添加 ^block-id at end of any paragraph/列出 item:

This is an 导入ant paragraph. ^key-insight

• 列出 item ^item-ref

Then link: [[Note Name#^key-insight]]

Block IDs: lowercase alphanumeric + dashes only.

Embeds ![[Note Name]] # embed entire note ![[Note Name#Heading]] # embed section ![[image.png]] # embed image ![[image.png|300]] # resize width 300px ![[image.png|300x200]] # exact dimensions ![[audio.mp3]] # embed audio player ![[video.mp4]] # embed video player ![[document.pdf]] # embed PDF ![[document.pdf#page=3]] # embed specific page

Supported 格式化s — see references/file-格式化s.md.

Callouts

[!note] Optional Title
Content with Markdown and [[wikilinks]].

[!tip]- Foldable (collapsed by default)
Hidden content.

[!警告]+ Foldable (expanded by default)
Shown content.

13 types: note, abstract/summary/tldr, 信息, todo, tip/hint/导入ant, 成功/检查/done, question/help/faq, 警告/caution/attention, 失败/fAIl/missing, danger/error, bug, example, quote/cite.

Other Obsidian 扩展s ==highlighted text== # highlight %%hidden comment%% # not rendered

• [ ] incomplete task # task
• [x] completed task # done task

$E = mc^2$ # inline LaTeX $$\int_0^\infty f(x)dx$$ # block LaTeX This is a footnote[^1]. # footnote [^1]: Footnote content.

Tags #tag # simple tag #parent/child # nested tag

Tags in body text or frontmatter. No spaces allowed.

MermAId Diagrams

graph TD
    A[启动] --> B{Decision}
    B -->|Yes| C[Action]
    B -->|No| D[End]

Canvas — JSON Canvas Spec 1.0

Full spec: references/canvas-spec.md

Quick Reference { "nodes": [ { "id": "node1", "type": "text", "x": 0, "y": 0, "width": 400, "height": 200, "text": "# Title\n\nMarkdown content", "color": "4" }, { "id": "node2", "type": "file", "x": 500, "y": 0, "width": 400, "height": 400, "file": "path/to/note.md", "subpath": "#heading" }, { "id": "node3", "type": "link", "x": 0, "y": 300, "width": 400, "height": 300, "url": "https://example.com" }, { "id": "group1", "type": "group", "x": -50, "y": -50, "width": 1000, "height": 500, "label": "Group Name", "color": "5" } ], "edges": [ { "id": "edge1", "fromNode": "node1", "fromSide": "right", "toNode": "node2", "toSide": "left", "color": "1", "label": "relates to" } ] }

Node types: text, file, link, group. Colors: "1" red, "2" orange, "3" yellow, "4" green, "5" cyan, "6" purple, or hex "#FF0000". Edge 端点s: fromEnd/toEnd → "none" or "arrow" (toEnd defaults to "arrow"). Sides: top, right, 机器人tom, left.

Canvas Layout Tips Use a grid: nodes at multiples of 50px Standard node: 400×200 (text), 400×400 (file/link) Groups: 50px p添加ing around contAIned nodes Nodes array order = z-索引 (last = top) File Naming kebab-case.md # note files YYYY-MM-DD-title.md # dAIly/dated notes kebab-case.canvas # canvas files

No spaces, no special chars, no CJK in filenames (for Git cross-平台 safety).

Vault Structure vault/ ├── 00-inbox/ # new/un排序ed notes ├── 01-projects/ # active projects ├── 02-areas/ # ongoing areas ├── 03-resources/ # reference material ├── 04-归档/ # 归档d notes ├── as设置s/ # images, PDFs, attachments ├── canvas/ # .canvas files ├── templates/ # note templates └── .gitignore

.gitignore .obsidian/workspace.json .obsidian/workspace-移动.json .obsidian/应用.json .trash/ .DS_