Editor/ Blueprint¶
Folder layout (future-proof)¶
cheatsheets/
ββ tools/
ββ editors/
ββ idea/
β ββ code-snippets.md # Live Templates, postfix tricks, surround templates
β ββ shortcuts.md # Keymap & combos
β ββ debugging.md # Breakpoints, watches, eval expr
β ββ configuration.md # Code style, inspections, file templates
β ββ run-configurations.md # App/Test/Spring Boot configs
β ββ settings-sync.md # Sync/export settings strategy
β ββ refactoring.md # Structural search/replace, safe delete, intentions
ββ vscode/
β ββ code-snippets.md # JSON snippets, multi-cursor patterns
β ββ shortcuts.md # Keybindings & chords
β ββ debugging.md # launch.json, DAP tips
β ββ configuration.md # settings.json, workspace vs user
β ββ extensions.md # Curated list w/ why + config
β ββ settings-sync.md
ββ vim/
ββ code-snippets.md # UltiSnips/Luasnip (optional)
ββ shortcuts.md
ββ configuration.md
File naming rules (simple + consistent)¶
- Keep one concept per file:
code-snippets.md,shortcuts.md,debugging.md,configuration.md. - Use editor folder to carry specificity. Inside
idea/,code-snippets.md= βIntelliJ Live Templates/snippetsβ. Insidevscode/, same name = VS Code snippets. - If a concept grows big, split with suffixes:
configuration-formatting.md,configuration-inspections.md.
Front matter template (uniform metadata)¶
Use the same front matter across all editor docs for fast filtering/search:
---
title: IDEA β Code Snippets
tags: [editors, idea, code, snippets]
summary: Live Templates, postfix, and surround examples for IntelliJ IDEA.
aliases:
---
Change only the title, tags, and summary per file:
-
tagssuggestions: -
IDEA:
[editors, idea, snippets],[editors, idea, debugging],[editors, idea, config] - VS Code:
[editors, vscode, snippets],[editors, vscode, extensions]
Optional: a tiny README index per editor¶
Add a minimal README.md inside each editor folder:
---
title: IDEA β Index
tags: [editors, idea]
summary: Entry points for all IntelliJ notes.
---
- [Code Snippets](./code-snippets.md)
- [Shortcuts](./shortcuts.md)
- [Debugging](./debugging.md)
- [Configuration](./configuration.md)
- [Run Configurations](./run-configurations.md)
- [Settings Sync](./settings-sync.md)
- [Refactoring](./refactoring.md)
This gives you a stable, parallel structure for IDEA, VS Code, and any future editor without bikeshedding filenames.