|
1 | | -# solenodontelabs-codenotes README |
| 1 | +# Code Notes 📝 |
2 | 2 |
|
3 | | -This is the README for your extension "solenodontelabs-codenotes". After writing up a brief description, we recommend including the following sections. |
| 3 | +Code Notes is a VS Code extension that lets you take structured notes across your codebase and quickly jump between code and the notes that describe it. |
4 | 4 |
|
5 | | -## Features |
| 5 | +It’s built for developers who: |
6 | 6 |
|
7 | | -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 7 | +- Leave TODOs but never find them again |
8 | 8 |
|
9 | | -For example if there is an image subfolder under your extension project workspace: |
| 9 | +- Keep random markdown files with scattered annotations |
10 | 10 |
|
11 | | -\!\[feature X\]\(images/feature-x.png\) |
| 11 | +- Review large codebases and want organized context |
12 | 12 |
|
13 | | -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. |
| 13 | +- Work in teams and want traceable, navigable notes |
14 | 14 |
|
15 | | -## Requirements |
| 15 | +- Code Notes gives you a dedicated sidebar to manage notes, reference exact files + lines, preview content, and jump back into the code instantly. |
16 | 16 |
|
17 | | -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
| 17 | +## ✨ Features |
18 | 18 |
|
19 | | -## Extension Settings |
| 19 | +### 📂 Notes Sidebar View |
20 | 20 |
|
21 | | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
| 21 | +- Browse all notes |
22 | 22 |
|
23 | | -For example: |
| 23 | +- Open, preview, and delete notes |
24 | 24 |
|
25 | | -This extension contributes the following settings: |
| 25 | +- Refresh with one click |
26 | 26 |
|
27 | | -* `myExtension.enable`: Enable/disable this extension. |
28 | | -* `myExtension.thing`: Set to `blah` to do something. |
| 27 | +### 🧭 Code References |
29 | 28 |
|
30 | | -## Known Issues |
| 29 | +- Attach notes to specific files + line numbers |
31 | 30 |
|
32 | | -Calling out known issues can help limit users opening duplicate issues against your extension. |
| 31 | +- Jump directly back to referenced code |
33 | 32 |
|
34 | | -## Release Notes |
| 33 | +- Works great for reviews, onboarding, debugging, refactoring |
35 | 34 |
|
36 | | -Users appreciate release notes as you update your extension. |
| 35 | +### ✍️ Simple Markdown Notes |
37 | 36 |
|
38 | | -### 1.0.0 |
| 37 | +- Notes are stored as readable Markdown |
39 | 38 |
|
40 | | -Initial release of ... |
| 39 | +- Easy to version, sync, and share |
41 | 40 |
|
42 | | -### 1.0.1 |
| 41 | +- You own your notes (no database, no vendor lock) |
43 | 42 |
|
44 | | -Fixed issue #. |
| 43 | +### ⚡ Fast Navigation |
45 | 44 |
|
46 | | -### 1.1.0 |
| 45 | +- Open notes from the tree view |
47 | 46 |
|
48 | | -Added features X, Y, and Z. |
| 47 | +- Open associated code reference in one click |
49 | 48 |
|
50 | | ---- |
| 49 | +### 📸 UI Overview |
51 | 50 |
|
52 | | -## Following extension guidelines |
| 51 | +> Screenshots coming soon |
53 | 52 |
|
54 | | -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. |
| 53 | +- Activity Bar → Code Notes |
55 | 54 |
|
56 | | -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) |
| 55 | +- Sidebar tree listing all your notes |
57 | 56 |
|
58 | | -## Working with Markdown |
| 57 | +- Commands available in the view header & context menu |
59 | 58 |
|
60 | | -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
| 59 | +## 🚀 Getting Started |
61 | 60 |
|
62 | | -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). |
63 | | -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). |
64 | | -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. |
| 61 | +### Installation |
65 | 62 |
|
66 | | -## For more information |
| 63 | +Install from VS Code Marketplace (coming soon) |
| 64 | +or |
67 | 65 |
|
68 | | -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
69 | | -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
| 66 | +Clone the repo & run: |
70 | 67 |
|
71 | | -**Enjoy!** |
| 68 | +```bash |
| 69 | +npm install |
| 70 | +npm run watch |
| 71 | +``` |
| 72 | + |
| 73 | +Then press F5 to launch the extension dev host. |
| 74 | + |
| 75 | +## 🎯 Core Commands |
| 76 | + |
| 77 | +| Command | Description | |
| 78 | +| ---------------------------------- | ----------------------------------------------- | |
| 79 | +| `Code Notes: Create Note` | Create a new note | |
| 80 | +| `Code Notes: Select Note` | Switch the active note | |
| 81 | +| `Code Notes: Add Reference` | Attach a code reference to a note | |
| 82 | +| `Code Notes: Go to Reference` | Jump to referenced file + line | |
| 83 | +| `Code Notes: View Note` | Open preview of current note | |
| 84 | +| `Code Notes: Open Notes Directory` | Open storage folder for notes | |
| 85 | +| `Code Notes: Delete Note` | Remove note | |
| 86 | +| `Code Notes: Refresh Tree` | Reload notes list | |
| 87 | +| `Code Notes: Open Note from Tree` | Open by clicking tree item | |
| 88 | +| `Code Notes: View Note at` | View note related to current cursor (if exists) | |
| 89 | + |
| 90 | +You’ll find most actions in: |
| 91 | + |
| 92 | +- Command Palette (Cmd/Ctrl + Shift + P) |
| 93 | +- Code Notes sidebar |
| 94 | +- Tree item right-click menus |
| 95 | + |
| 96 | +## 🗂️ Where are notes stored? |
| 97 | + |
| 98 | +Notes are stored locally in a Markdown directory (managed by the extension). |
| 99 | + |
| 100 | +They’re human readable and version-control friendly. |
| 101 | + |
| 102 | +## 🔧 Roadmap |
| 103 | + |
| 104 | +Planned improvements include: |
| 105 | + |
| 106 | +- Search & filtering |
| 107 | + |
| 108 | +- Workspace-shared notes option |
| 109 | + |
| 110 | +- Inline commenting UX |
| 111 | + |
| 112 | +- Multiple notes per line |
| 113 | + |
| 114 | +If you have ideas or feature requests, open an issue! |
| 115 | + |
| 116 | +## ❤️ Sponsor |
| 117 | + |
| 118 | +If this helps your workflow, consider sponsoring: |
| 119 | +👉 https://github.com/sponsors/kyonru |
| 120 | + |
| 121 | +## 🏷️ License |
| 122 | + |
| 123 | +MIT — feel free to hack, extend, and share. |
0 commit comments