Skip to content

Commit d2d39fc

Browse files
committed
add build steps
1 parent f001f21 commit d2d39fc

File tree

2 files changed

+110
-38
lines changed

2 files changed

+110
-38
lines changed

.github/workflows/deploy.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
on:
2+
push:
3+
tags:
4+
- "*"
5+
6+
name: Deploy Extension
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v4
12+
- uses: actions/setup-node@v4
13+
with:
14+
node-version: 20
15+
- run: npm ci
16+
- name: Publish to Visual Studio Marketplace
17+
uses: HaaLeo/publish-vscode-extension@v2
18+
with:
19+
pat: ${{ secrets.VS_MARKETPLACE_TOKEN }}
20+
registryUrl: https://marketplace.visualstudio.com

README.md

Lines changed: 90 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,123 @@
1-
# solenodontelabs-codenotes README
1+
# Code Notes 📝
22

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.
44

5-
## Features
5+
It’s built for developers who:
66

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
88

9-
For example if there is an image subfolder under your extension project workspace:
9+
- Keep random markdown files with scattered annotations
1010

11-
\!\[feature X\]\(images/feature-x.png\)
11+
- Review large codebases and want organized context
1212

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
1414

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.
1616

17-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
17+
## ✨ Features
1818

19-
## Extension Settings
19+
### 📂 Notes Sidebar View
2020

21-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
21+
- Browse all notes
2222

23-
For example:
23+
- Open, preview, and delete notes
2424

25-
This extension contributes the following settings:
25+
- Refresh with one click
2626

27-
* `myExtension.enable`: Enable/disable this extension.
28-
* `myExtension.thing`: Set to `blah` to do something.
27+
### 🧭 Code References
2928

30-
## Known Issues
29+
- Attach notes to specific files + line numbers
3130

32-
Calling out known issues can help limit users opening duplicate issues against your extension.
31+
- Jump directly back to referenced code
3332

34-
## Release Notes
33+
- Works great for reviews, onboarding, debugging, refactoring
3534

36-
Users appreciate release notes as you update your extension.
35+
### ✍️ Simple Markdown Notes
3736

38-
### 1.0.0
37+
- Notes are stored as readable Markdown
3938

40-
Initial release of ...
39+
- Easy to version, sync, and share
4140

42-
### 1.0.1
41+
- You own your notes (no database, no vendor lock)
4342

44-
Fixed issue #.
43+
### ⚡ Fast Navigation
4544

46-
### 1.1.0
45+
- Open notes from the tree view
4746

48-
Added features X, Y, and Z.
47+
- Open associated code reference in one click
4948

50-
---
49+
### 📸 UI Overview
5150

52-
## Following extension guidelines
51+
> Screenshots coming soon
5352
54-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
53+
- Activity Bar → Code Notes
5554

56-
* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines)
55+
- Sidebar tree listing all your notes
5756

58-
## Working with Markdown
57+
- Commands available in the view header & context menu
5958

60-
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
59+
## 🚀 Getting Started
6160

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
6562

66-
## For more information
63+
Install from VS Code Marketplace (coming soon)
64+
or
6765

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:
7067

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

Comments
 (0)