📝 Add documentation guide for Obsidian usage
This commit is contained in:
335
docs/OBSIDIAN_GUIDE.md
Normal file
335
docs/OBSIDIAN_GUIDE.md
Normal file
@@ -0,0 +1,335 @@
|
||||
---
|
||||
type: reference
|
||||
created: 2026-01-26
|
||||
tags: [obsidian, guide, tutorial]
|
||||
---
|
||||
|
||||
# Obsidian MD for VSCode Guide
|
||||
|
||||
A comprehensive guide to using Obsidian MD extension within VS Code for your Memory Palace.
|
||||
|
||||
## What is Obsidian MD for VSCode?
|
||||
|
||||
Obsidian MD for VSCode brings the power of Obsidian's knowledge management features directly into VS Code. You can use wiki-links, backlinks, graph view, and daily notes without leaving your editor.
|
||||
|
||||
## Key Features
|
||||
|
||||
### 1. Wiki-Links
|
||||
|
||||
Create bidirectional links between notes using `[[double brackets]]`:
|
||||
|
||||
```markdown
|
||||
This is a note about [[Memory Techniques]] that relates to [[Spaced Repetition]].
|
||||
```
|
||||
|
||||
- **Ctrl/Cmd + Click** on a link to navigate
|
||||
- Links to non-existent notes show up differently (you can create them on click)
|
||||
- Works with paths: `[[docs/concepts/memory-techniques]]`
|
||||
|
||||
### 2. Backlinks
|
||||
|
||||
See all notes that link to the current note:
|
||||
|
||||
- Open **Command Palette** (Cmd+Shift+P)
|
||||
- Search for "Obsidian: Show Backlinks"
|
||||
- A panel shows all incoming links to current note
|
||||
|
||||
### 3. Graph View
|
||||
|
||||
Visualize your note connections:
|
||||
|
||||
- Open **Command Palette** (Cmd+Shift+P)
|
||||
- Search for "Obsidian: Open Graph View"
|
||||
- See your knowledge graph with nodes (notes) and edges (links)
|
||||
- Click nodes to navigate
|
||||
|
||||
### 4. Daily Notes
|
||||
|
||||
Quick access to today's note:
|
||||
|
||||
- **Command Palette** → "Obsidian: Open Today's Daily Note"
|
||||
- Configured to save in `docs/daily/` as `daily-YYYY-MM-DD.md`
|
||||
- Great for quick captures, journal entries, and daily logs
|
||||
|
||||
### 5. Quick Switcher
|
||||
|
||||
Fast navigation between notes:
|
||||
|
||||
- Open **Command Palette**
|
||||
- Search for "Obsidian: Quick Switcher"
|
||||
- Type note name to jump to it instantly
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Organize Your Notes
|
||||
|
||||
```
|
||||
docs/
|
||||
├── daily/ # Daily journals and quick captures
|
||||
├── concepts/ # Evergreen, refined knowledge
|
||||
├── projects/ # Project-specific documentation
|
||||
├── fleeting/ # Temporary notes to process later
|
||||
└── reference-material/ # Resources and references
|
||||
```
|
||||
|
||||
### Use Frontmatter
|
||||
|
||||
Add metadata to every note for better organization:
|
||||
|
||||
```markdown
|
||||
---
|
||||
type: concept|project|fleeting|reference
|
||||
created: 2026-01-26
|
||||
updated: 2026-01-26
|
||||
tags: [programming, javascript, bookmarklets]
|
||||
status: draft|in-progress|complete
|
||||
---
|
||||
|
||||
# Note Title
|
||||
```
|
||||
|
||||
### Link Liberally
|
||||
|
||||
Don't overthink links - add them as you write:
|
||||
|
||||
- Link to concepts: `[[memory techniques]]`
|
||||
- Link to projects: `[[paperlyte]]`
|
||||
- Link to daily notes: `[[daily-2026-01-26]]`
|
||||
|
||||
The graph view will reveal patterns over time.
|
||||
|
||||
### Progressive Summarization
|
||||
|
||||
1. **Capture** - Write fleeting notes in `docs/fleeting/`
|
||||
2. **Connect** - Add links to related concepts
|
||||
3. **Refine** - Move to `docs/concepts/` when mature
|
||||
4. **Highlight** - Bold key insights
|
||||
5. **Summarize** - Add overview sections
|
||||
|
||||
### Zettelkasten Method
|
||||
|
||||
Create atomic notes (one idea per note):
|
||||
|
||||
```markdown
|
||||
# Memory Palace Technique
|
||||
|
||||
A mnemonic device using spatial memory.
|
||||
|
||||
## Core Concept
|
||||
|
||||
Associate information with specific locations in a familiar space.
|
||||
|
||||
## Related
|
||||
- [[Spaced Repetition]]
|
||||
- [[Mnemonic Devices]]
|
||||
- [[Method of Loci]]
|
||||
|
||||
## References
|
||||
- [[reference-material/moonwalking-with-einstein]]
|
||||
```
|
||||
|
||||
### MOC (Map of Content)
|
||||
|
||||
Create index notes for topics:
|
||||
|
||||
```markdown
|
||||
# JavaScript MOC
|
||||
|
||||
## Core Concepts
|
||||
- [[ES Modules]]
|
||||
- [[Async/Await]]
|
||||
- [[Closures]]
|
||||
|
||||
## Projects
|
||||
- [[bookmarklets/README]]
|
||||
- [[scratchpad/experiments]]
|
||||
|
||||
## Resources
|
||||
- [[reference-material/you-dont-know-js]]
|
||||
```
|
||||
|
||||
## Workflows
|
||||
|
||||
### Capture Quick Thoughts
|
||||
|
||||
1. Open today's daily note (Command Palette → Obsidian: Open Today's Daily Note)
|
||||
2. Write thoughts under `## Quick Captures`
|
||||
3. Add links to related notes
|
||||
4. Process later by moving to permanent notes
|
||||
|
||||
### Research & Learning
|
||||
|
||||
1. Create fleeting note in `docs/fleeting/`
|
||||
2. Add source links and highlights
|
||||
3. Connect to existing concepts with `[[wiki-links]]`
|
||||
4. When understanding solidifies, refine into concept note
|
||||
5. Archive or delete fleeting note
|
||||
|
||||
### Project Documentation
|
||||
|
||||
1. Create project folder in `docs/projects/[project-name]/`
|
||||
2. Add `README.md` as entry point
|
||||
3. Link to related concepts and resources
|
||||
4. Use daily notes to log progress
|
||||
5. Link daily entries back to project README
|
||||
|
||||
### Code + Documentation Together
|
||||
|
||||
Since this is a hybrid workspace:
|
||||
|
||||
```markdown
|
||||
# Bookmarklet: Highlight Links
|
||||
|
||||
## Overview
|
||||
Highlights all links on a page.
|
||||
|
||||
## Implementation
|
||||
See [[code/bookmarklets/highlight-links.js]]
|
||||
|
||||
## Usage
|
||||
Generated via: `npm run bookmarklet -- code/bookmarklets/highlight-links.js`
|
||||
|
||||
## Related
|
||||
- [[JavaScript Bookmarklets]]
|
||||
- [[Browser DOM Manipulation]]
|
||||
```
|
||||
|
||||
## Keyboard Shortcuts
|
||||
|
||||
Configure these in VS Code settings for faster workflow:
|
||||
|
||||
- **Quick Switcher**: Set custom keybinding
|
||||
- **Daily Note**: Set custom keybinding (e.g., Cmd+Shift+D)
|
||||
- **Graph View**: Set custom keybinding (e.g., Cmd+Shift+G)
|
||||
- **Follow Link**: Cmd+Click (built-in)
|
||||
- **Go Back**: Cmd+- (VS Code navigation)
|
||||
|
||||
## Tips & Tricks
|
||||
|
||||
### Use Aliases in Frontmatter
|
||||
|
||||
```markdown
|
||||
---
|
||||
aliases: [ML, Machine Learning, AI Learning]
|
||||
---
|
||||
|
||||
# Machine Learning Concepts
|
||||
```
|
||||
|
||||
Now you can link with any alias: `[[ML]]` or `[[Machine Learning]]`
|
||||
|
||||
### Embed Notes
|
||||
|
||||
Show content from other notes:
|
||||
|
||||
```markdown
|
||||
## Memory Technique Summary
|
||||
![[memory-palace-technique]]
|
||||
```
|
||||
|
||||
### Use Tags Strategically
|
||||
|
||||
```markdown
|
||||
---
|
||||
tags: [in-progress, needs-review, high-priority]
|
||||
---
|
||||
```
|
||||
|
||||
Search by tag using VS Code's search: `#in-progress`
|
||||
|
||||
### Combine with Todo Tree
|
||||
|
||||
```markdown
|
||||
## TODO List
|
||||
- TODO: Research spaced repetition algorithms
|
||||
- FIXME: Update outdated references
|
||||
- IDEA: Create MOC for learning techniques
|
||||
```
|
||||
|
||||
These show up in Todo Tree extension sidebar.
|
||||
|
||||
### Use Templates
|
||||
|
||||
Create templates in `docs/templates/`:
|
||||
|
||||
```markdown
|
||||
<!-- docs/templates/concept-note.md -->
|
||||
---
|
||||
type: concept
|
||||
created: {{date}}
|
||||
tags: []
|
||||
---
|
||||
|
||||
# {{title}}
|
||||
|
||||
## Overview
|
||||
|
||||
## Details
|
||||
|
||||
## Examples
|
||||
|
||||
## Related
|
||||
-
|
||||
|
||||
## References
|
||||
-
|
||||
```
|
||||
|
||||
## Obsidian vs Foam
|
||||
|
||||
You've switched from Foam to Obsidian MD. Here are the differences:
|
||||
|
||||
| Feature | Foam | Obsidian MD |
|
||||
|---------|------|-------------|
|
||||
| Graph View | ✓ | ✓ (Better visualization) |
|
||||
| Backlinks | ✓ | ✓ |
|
||||
| Wiki-links | ✓ | ✓ |
|
||||
| Daily Notes | ✓ | ✓ |
|
||||
| Quick Switcher | ✗ | ✓ |
|
||||
| Community | Good | Larger |
|
||||
| Obsidian App Integration | ✗ | ✓ Can open in Obsidian app |
|
||||
| Performance | Good | Better for large vaults |
|
||||
|
||||
## Integration with Obsidian App (Optional)
|
||||
|
||||
You can also open this workspace in the actual Obsidian app:
|
||||
|
||||
1. Install [Obsidian](https://obsidian.md/)
|
||||
2. Open as vault: `/Users/fragginwagon/Developer/MemoryPalace`
|
||||
3. Edit in Obsidian or VS Code - they sync automatically
|
||||
4. Use Obsidian's mobile app for notes on the go
|
||||
|
||||
Benefits:
|
||||
- Richer graph view with filters
|
||||
- More theme options
|
||||
- Mobile app for capture
|
||||
- Community plugins (dataview, calendar, etc.)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**Links not working?**
|
||||
- Check `obsidian.vaultPath` in [.vscode/settings.json](.vscode/settings.json)
|
||||
- Ensure path is `/Users/fragginwagon/Developer/MemoryPalace`
|
||||
|
||||
**Graph view not showing?**
|
||||
- Create more notes with `[[links]]`
|
||||
- Graph appears when you have interconnected notes
|
||||
|
||||
**Daily notes in wrong location?**
|
||||
- Check `obsidian.dailyNotePath` setting
|
||||
- Should be `docs/daily`
|
||||
|
||||
## Resources
|
||||
|
||||
- [Obsidian Help](https://help.obsidian.md/)
|
||||
- [Linking Your Thinking (YouTube)](https://www.youtube.com/c/NickMilo)
|
||||
- [Zettelkasten Method](https://zettelkasten.de/)
|
||||
- [Building a Second Brain](https://www.buildingasecondbrain.com/)
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. Open today's daily note and start capturing thoughts
|
||||
2. Create a few concept notes with `[[links]]`
|
||||
3. View your graph to see connections
|
||||
4. Explore backlinks panel for any note
|
||||
5. Create a MOC for your main interest areas
|
||||
Reference in New Issue
Block a user