CLAUDE.md¶
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Repository Overview¶
This is an Obsidian vault - a personal knowledge management system. Obsidian is a markdown-based note-taking application that stores notes as plain text files with .md extensions. The vault contains personal notes, templates, and various organizational structures.
Vault Structure¶
- 00Inbox/: Incoming notes and unprocessed content
- 00template/: Note templates used for creating new notes
Daily_Questions.md: Template for AI Q&A sessions with dataview integration日记模版.md: Daily notes template (Chinese)Meeting Minute.md: Meeting notes template- 01DailyNotes/: Daily journal entries (managed by daily-notes plugin)
- 01Attachment/: Attachments and media files
- Classic/: Classic or archived content
- Clippings/: Web clippings and saved articles
- Daily Notes/: Additional daily notes storage
- Day Planners/: Day planning notes
- Excalidraw/: Excalidraw diagrams
- Work/: Work-related notes
- Root directory: Contains individual notes on various topics
Key Obsidian Plugins¶
Core plugins enabled:
- daily-notes: Creates daily notes in 01DailyNotes/ with format YYYYMMDD(DDDo) ddd(wo)
- templates: Template insertion system
- graph, backlink, outgoing-link: Note relationship visualization
- canvas: Visual canvas for organizing notes
- bookmarks: Bookmarking system
- bases: Base files support (.base extensions)
Community plugins:
- obsidian-git: Auto-commits vault with message format vault backup: {{date}} (YYYY-MM-DD HH:mm:ss)
- dataview: Enables dataviewjs queries in notes (see templates)
- obsidian-tasks-plugin: Task management
- obsidian-kanban: Kanban boards
- obsidian-day-planner: Day planning functionality
- obsidian-custom-attachment-location: Stores attachments in ./assets/${noteFileName}/
- remotely-save: Remote synchronization
- text-extractor: Text extraction from images/PDFs
- obsidian-local-rest-api: REST API access
- obsidian-enhancing-export: Enhanced export capabilities
Git Integration¶
The vault uses the obsidian-git plugin with these settings:
- Auto-backup after file changes
- Commit message format: vault backup: {{date}} (YYYY-MM-DD HH:mm:ss)
- Pull before push is enabled
- Sync method: merge
When committing changes manually, follow the existing commit message format or use descriptive messages for non-automated commits.
Attachment Management¶
Attachments are automatically organized by the custom-attachment-location plugin:
- Location: ./assets/${noteFileName}/
- Naming: file-${date:YYYYMMDDHHmmssSSS}
- Markdown format: assets/${noteFileName}/${generatedAttachmentFileName}
When referencing images or files in notes, use relative paths following this pattern.
Note Conventions¶
- The vault contains notes in both English and Chinese
- Date-prefixed notes use format:
YYYYMMDD - Title.md - Tags are commonly used (e.g.,
#待分类) - Dataviewjs queries are used in templates for dynamic content
- Links use relative markdown format (configured in app.json)
Working with Templates¶
When creating new notes from templates:
- Templates use {{DATE}} placeholder
- Daily notes template includes dataviewjs for extracting bullet points
- Templates include frontmatter with date, tags, and related fields
Important Notes¶
- This is a personal knowledge vault, not a software project - there are no build, test, or lint commands
- Avoid modifying
.obsidian/configuration files unless specifically requested - Respect the existing folder structure and naming conventions
- The
.gitignoreonly excludes workspace files (workspace.json,workspace-mobile.json) - When creating or modifying notes, maintain the existing markdown style and frontmatter format