@@ -36,51 +36,55 @@ Codebase Notebook is a VS Code extension that lets you take structured notes acr
3636
3737### 📸 UI Overview
3838
39- ![ example ] ( preview.gif )
39+ ![ Example ] ( https://raw.githubusercontent.com/Kyonru/code-notes/main/ preview.gif)
4040
4141- Activity Bar → Codebase Notebook
4242
4343- Sidebar tree listing all your notes
4444
4545- Commands available in the view header & context menu
4646
47- ## 🚀 Getting Started
47+ ## ⚙️ Configuration
4848
49- ### Installation
49+ You can customize where Codebase Notebook stores your notes.
5050
51- Install from VS Code Marketplace (coming soon)
52- or
51+ Add this in ** Settings → Search “Codebase Notebook”** or in your ` settings.json ` :
5352
54- Clone the repo & run:
55-
56- ``` bash
57- npm install
58- npm run watch
53+ ``` json
54+ {
55+ "crosscodenotes.notesDirectory" : " "
56+ }
5957```
6058
61- Then press F5 to launch the extension dev host.
62-
6359## 🎯 Core Commands
6460
65- | Command | Description |
66- | ----------------------------------------- | ----------------------------------------------- |
67- | ` Codebase Notebook: Create Note ` | Create a new note |
68- | ` Codebase Notebook: Select Note ` | Switch the active note |
69- | ` Codebase Notebook: Add Reference ` | Attach a code reference to a note |
70- | ` Codebase Notebook: Go to Reference ` | Jump to referenced file + line |
71- | ` Codebase Notebook: View Note ` | Open preview of current note |
72- | ` Codebase Notebook: Open Notes Directory ` | Open storage folder for notes |
73- | ` Codebase Notebook: Delete Note ` | Remove note |
74- | ` Codebase Notebook: Refresh Tree ` | Reload notes list |
75- | ` Codebase Notebook: Open Note from Tree ` | Open by clicking tree item |
76- | ` Codebase Notebook: View Note at ` | View note related to current cursor (if exists) |
61+ | Command | Description |
62+ | ------------------------------------------- | -------------------------------------------- |
63+ | ` Codebase Notebook: Create Note ` | Create a new note |
64+ | ` Codebase Notebook: Select Note ` | Switch the active note |
65+ | ` Codebase Notebook: Add Reference ` | Attach a code reference to a note |
66+ | ` Codebase Notebook: Go to Reference ` | Jump to referenced file + line |
67+ | ` Codebase Notebook: View Note ` | Open preview of current note |
68+ | ` Codebase Notebook: Open Notes Directory ` | Open storage folder for notes |
69+ | ` Codebase Notebook: Delete Note ` | Remove note |
70+ | ` Codebase Notebook: Refresh Notes ` | Reload the notes list |
71+ | ` Codebase Notebook: Open Note from Tree ` | Open a note directly from the tree view |
72+ | ` Codebase Notebook: View Note at ` | View note related to the current cursor |
73+ | ` Codebase Notebook: Search Notes ` | Search existing notes |
74+ | ` Codebase Notebook: Change Notes Directory ` | Select / change the directory used for notes |
7775
7876You’ll find most actions in:
7977
8078- Command Palette (Cmd/Ctrl + Shift + P)
8179- Codebase Notebook sidebar
8280- Tree item right-click menus
8381
82+ ## ⌨️ Keybindings
83+
84+ | Action | Windows / Linux | macOS |
85+ | ------------------------- | ------------------ | ----------------- |
86+ | Add Reference to Notebook | ` Ctrl + Shift + J ` | ` Cmd + Shift + J ` |
87+
8488## 🗂️ Where are notes stored?
8589
8690Notes are stored locally in a Markdown directory (managed by the extension).
@@ -89,6 +93,12 @@ They’re human readable and version-control friendly.
8993
9094If you have ideas or feature requests, open an issue!
9195
96+ ## 🔧 Roadmap
97+
98+ - Rename
99+ - Improved Note taking
100+ - Multi Line Notes and Highlighting
101+
92102## ❤️ Sponsor
93103
94104If this helps your workflow, consider sponsoring:
0 commit comments