Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
prmichaelsen authored Sep 4, 2023
1 parent d8fb031 commit 969c248
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Line Note Plus

Line Note Plus is a VSCode extension to add Markdown notes to your code
that are visible when hovering over the noted line.
that are visible when hovering over the noted line. Based on [Line Note](https://github.com/tkrkt/linenote).

![img](https://storage.googleapis.com/com-f5-parm.appspot.com/parm/images/n4kPfVDbsTs5Z4bGgPEU.png)
<img width="1090" alt="basic-demo" src="https://github.com/prmichaelsen/linenoteplus/assets/8428140/0ecb3057-2334-4413-b0aa-71889ae14a6b">

[VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=prmichaelsen.linenoteplus)

Expand All @@ -12,7 +12,7 @@ that are visible when hovering over the noted line.
Invoke `Add note at current position` from the command palette or context menu.
You can see the note you wrote as hover text.

Notes are saved in `$PROJECT_ROOT/.vscode/linenoteplus` like `.vscode/linenoteplus/<short-uid>.md`.
Notes are saved in `$PROJECT_ROOT/.vscode/linenoteplus` like `.vscode/.linenoteplus/<short-uid>.md`.

### API
#### Commands
Expand All @@ -32,23 +32,24 @@ Notes are saved in `$PROJECT_ROOT/.vscode/linenoteplus` like `.vscode/linenotepl

### Demos
#### Adding a note
![img](https://storage.googleapis.com/com-f5-parm.appspot.com/parm/images/JshIno5UinQhjslG3s2b.gif)
![add-note](https://github.com/prmichaelsen/linenoteplus/assets/8428140/85a41396-6ea5-4621-9621-ac77972448b1)

#### Custom note title
![img](https://storage.googleapis.com/com-f5-parm.appspot.com/parm/images/MjXozQ9OmQXepBWUHBEA.gif)
![custom-name](https://github.com/prmichaelsen/linenoteplus/assets/8428140/558907e7-538a-49c3-9099-45daed825b37)

#### Notes move with code changes
![img](https://storage.googleapis.com/com-f5-parm.appspot.com/parm/images/R41NCUtlK0QLMevLGZjg.gif)
![moves-with-code](https://github.com/prmichaelsen/linenoteplus/assets/8428140/569280b2-3b65-4872-8a8a-85d5011c8f8c)

#### Notes can be moved across files
![img](https://storage.googleapis.com/com-f5-parm.appspot.com/parm/images/k2WHfD9NNexokMJCzctm.gif)
![move-notes-across-files](https://github.com/prmichaelsen/linenoteplus/assets/8428140/cdb578c8-7a0f-4894-ad4c-dba5f71f2d00)


#### Reveal notated line command
![img](https://storage.googleapis.com/com-f5-parm.appspot.com/parm/images/ROAAP5g2mWTshARomUBA.gif)
![reveal-notated-file](https://github.com/prmichaelsen/linenoteplus/assets/8428140/e3d4f76a-67e1-4603-abd4-8a3dcedec15a)

#### Refactor does not affect notes
![refactor-does-not-affect-notes](https://github.com/prmichaelsen/linenoteplus/assets/8428140/d034f397-ebd7-4fa6-9843-4cb3f2c26c9e)

#### Video demos
* Adding and removing notes: https://storage.googleapis.com/com-f5-parm.appspot.com/parm/images/XK7AHFrBrfD7LpliwDX5.quicktime
* Notes move with code: https://storage.googleapis.com/com-f5-parm.appspot.com/parm/images/KbetjziHdRWmfHpJu5FN.quicktime

### Acknowledgements
Line Note Plus is a fork of Line Note by tkrkt. This library's design
Expand All @@ -58,4 +59,4 @@ was also informed by Marginalia by indiejames.


### Known Bugs
* Gutter icon does note display.
* Gutter icon does not display.

0 comments on commit 969c248

Please sign in to comment.