mcpField
O
obsidian-vault

obsidian-vault

github.com/vinvcnProductivity5.4k2.1k installsUpdated 1d ago
Repository

About obsidian-vault

obsidian-vault is a set of conventions for maintaining an Obsidian vault, covering note names, indexes, links, and search. It supports workflows for organizing AI Research notes in a mostly flat structure.

Key features

  1. 01Use Title Case for note names
  2. 02Group topics with index notes
  3. 03Link notes with wikilinks
  4. 04Search filenames or note content
  5. 05Add related-note links at the bottom

Use cases

  1. 01Create topic index notes
  2. 02Find related content in the vault
  3. 03Create notes that follow naming conventions
  4. 04Discover linked notes through backlinks

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/vinvcn/mattpocock-skills-zh-cn --skill obsidian-vault

After installing, type/obsidian-vaultin Claude Code to confirm it loaded.

Bundled filesagents/openai.yaml

Details

From the project README

Obsidian Vault

Vault location

/mnt/d/Obsidian Vault/AI Research/

root level 基本保持扁平。

Naming conventions

  • Index notes:聚合相关 topics(例如 Ralph Wiggum Index.md、Skills Index.md、RAG Index.md)
  • 所有 note names 使用 Title case
  • 不用 folders 做组织;改用 links 和 index notes

Linking

  • 使用 Obsidian [[wikilinks]] syntax:[[Note Title]]
  • Notes 在底部链接 dependencies/related notes
  • Index notes 只是 [[wikilinks]] 列表

Workflows

Search for notes
# Search by filename
find "/mnt/d/Obsidian Vault/AI Research/" -name "*.md" | grep -i "keyword"

# Search by content
grep -rl "keyword" "/mnt/d/Obsidian Vault/AI Research/" --include="*.md"

或直接在 vault path 上使用 Grep/Glob tools。

Create a new note
  1. filename 使用 Title Case
  2. 按 vault rules,把内容写成一个 learning unit
  3. 在底部添加指向 related notes 的 [[wikilinks]]
  4. 如果属于 numbered sequence,使用 hierarchical numbering scheme
Find related notes

在 vault 中搜索 [[Note Title]] 来找 backlinks:

grep -rl "\\[\\[Note Title\\]\\]" "/mnt/d/Obsidian Vault/AI Research/"
Find index notes
find "/mnt/d/Obsidian Vault/AI Research/" -name "*Index*"

Comments

Markdown supported