📚 Update README with enhanced Obsidian-specific documentation, commands, and features

This commit is contained in:
2026-01-26 22:35:24 +00:00
parent d6f71c0023
commit 3004446a29

View File

@@ -2,6 +2,12 @@
A hybrid workspace combining Obsidian-style knowledge management with code development. A hybrid workspace combining Obsidian-style knowledge management with code development.
## 📚 Documentation
**New to this workspace?**
- Setup: See [SETUP.md](SETUP.md) for installation on a new computer
- Obsidian Guide: See [docs/OBSIDIAN_GUIDE.md](docs/OBSIDIAN_GUIDE.md) for comprehensive guide
## 📁 Structure ## 📁 Structure
### Documentation (`/docs`) ### Documentation (`/docs`)
@@ -30,9 +36,10 @@ A hybrid workspace combining Obsidian-style knowledge management with code devel
### Creating Notes ### Creating Notes
- Press `Cmd+Shift+P` and type "Foam: Create New Note" to create a linked note - Press `Cmd+Shift+P` and type "Obsidian: Open Today's Daily Note" for daily notes
- Use `[[wiki-style links]]` to connect notes - Use `[[wiki-style links]]` to connect notes
- Daily notes: "Foam: Open Daily Note" - Quick Switcher: "Obsidian: Quick Switcher" to navigate between notes
- Graph View: "Obsidian: Open Graph View" to visualize connections
### Linking Notes ### Linking Notes
@@ -50,9 +57,10 @@ A hybrid workspace combining Obsidian-style knowledge management with code devel
### Documentation Features ### Documentation Features
- **Wiki-style linking** - Connect ideas with `[[links]]` - **Wiki-style linking** - Connect ideas with `[[links]]` ("Obsidian: Show Backlinks")
- **Backlinks** - See which notes reference the current note - **Graph visualization** - Visual map of your knowledge ("Obsidian: Open Graph View")
- **Graph visualization** - Visual map of your knowledge - **Daily notes** - Quick capture with today's note ("Obsidian: Open Today's Daily Note")
- **Quick Switcher** - Fast navigation between notesowledge
- **Daily notes** - Automatic daily note creation - **Daily notes** - Automatic daily note creation
### Code Features ### Code Features
@@ -62,16 +70,17 @@ A hybrid workspace combining Obsidian-style knowledge management with code devel
- **Code bookmarks** - Mark important code sections - **Code bookmarks** - Mark important code sections
- **Todo tracking** - Track TODOs across all files - **Todo tracking** - Track TODOs across all files
## 🎯 Useful Commands ## 🎯 Useful Comma | Shortcut | Description |
| ------------------ | ---------- | ----------------------------------- |
| Command | Shortcut | Description | | Daily Note | - | Obsidian: Open Today's Daily Note |
| --------------- | ---------- | ------------------------- | | Quick Switcher | - | Obsidian: Quick Switcher |
| Create New Note | - | Foam: Create New Note | | Show Graph | - | Obsidian: Open Graph View |
| Open Daily Note | - | Foam: Open Daily Note | | Show Backlinks | - | Obsidian: Show Backlinks |
| Show Graph | - | Foam: Show Graph |
| Run Code | Ctrl+Alt+N | Execute current file | | Run Code | Ctrl+Alt+N | Execute current file |
| Toggle Bookmark | Cmd+Alt+K | Mark/unmark code location | | Toggle Bookmark | Cmd+Alt+K | Mark/unmark code location |
| Show Todos | - | Todo Tree: Focus on View | | Show Todos | - | Todo Tree: Focus on View |
| Toggle Bookmark | Cmd+Alt+K | Mark/unmark code location |
| Show Todos | - | Todo Tree: Focus on View |
## 🔍 Search Tips ## 🔍 Search Tips