Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kortina committed May 31, 2020
1 parent 3bb61bd commit b1024e8
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 15 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# VS Code Markdown Notes

Use `[[wiki-links]]` and `#tags` for fast-navigation between notes kept in in a VS Code workspace. Quickly create new notes from a Title Case Note Name.
Use `[[wiki-links]]`, `backlinks`, and `#tags` for fast-navigation of markdown notes.

There are many great note-taking applications ([Notational Velocity](http://notational.net/), [nvalt](https://brettterpstra.com/projects/nvalt/), [Bear](https://bear.app/), [FSNotes](https://fsnot.es/)), but few of them offer the extensibility of VS Code and the ability to use Vim bindings for editing notes.
Automatically create notes from new inline `[[wiki-links]]`.

This extension provides a number of the best features invented by these other great apps.
Bring some of the awesome features from apps like [Notational Velocity](http://notational.net/), [nvalt](https://brettterpstra.com/projects/nvalt/), [Bear](https://bear.app/), [FSNotes](https://fsnot.es/), [Obsidian](https://obsidian.md/) to VS Code, where you also have (1) Vim key bindings and (2) excellent extensibility.

You can [install it from the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes). See also my other customizations for note-taking in this blog post: [Suping Up VS Code as a Markdown Notebook](https://kortina.nyc/essays/suping-up-vs-code-as-a-markdown-notebook/).
[Install from the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=kortina.vscode-markdown-notes). See more in the blog post: [Suping Up VS Code as a Markdown Notebook](https://kortina.nyc/essays/suping-up-vs-code-as-a-markdown-notebook/).

### `[[wiki-links]]`

Expand Down Expand Up @@ -35,6 +35,10 @@ You can bind this to a keyboard shortcut by adding to your `keybindings.json`:

### Screenshots

#### Create New Note On Missing Go To Definition

![create-note-on-missing-go-to-definition](demo/create-note-on-missing-go-to-definition.gif)

#### Intellisense Completion for Wiki Links, `uniqueFilenames`

![completion-unique-filenames](demo/completion-unique-filenames.gif)
Expand All @@ -43,6 +47,10 @@ You can bind this to a keyboard shortcut by adding to your `keybindings.json`:

![completion-relative-paths](demo/completion-relative-paths.gif)

### Backlinks Explorer Panel

![backlinks](demo/backlinks.gif)

#### Syntax Highlighting for Tags and Wiki Links

![syntax-highlighting](demo/syntax-highlighting.png)
Expand All @@ -51,14 +59,6 @@ You can bind this to a keyboard shortcut by adding to your `keybindings.json`:

![peek-and-go-to-definition](demo/peek-and-go-to-definition.gif)

#### Create New Note On Missing Go To Definition

![create-note-on-missing-go-to-definition](demo/create-note-on-missing-go-to-definition.gif)

#### New Note Command

![new-note-command](demo/new-note-command.gif)

#### Peek References to Wiki Links

![peek-references-wiki-link](demo/peek-references-wiki-link.png)
Expand All @@ -79,6 +79,10 @@ You can bind this to a keyboard shortcut by adding to your `keybindings.json`:

![tag-search](demo/tag-search.gif)

#### New Note Command

![new-note-command](demo/new-note-command.gif)

## dev

Run `npm install` first.
Expand Down
Binary file added demo/backlinks.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "vscode-markdown-notes",
"displayName": "VS Code Markdown Notes",
"description": "Navigate notes with [[wiki-links]] and #tags (like Bear, Roam, etc). Use Peek Definition to preview linked notes. Quickly create new notes with a command.",
"description": "Navigate notes with [[wiki-links]], backlinks, and #tags (like Bear, Roam, etc). Automatically create notes from new inline [[wiki-links]]. Use Peek Definition to preview linked notes.",
"version": "0.0.9",
"publisher": "kortina",
"repository": {
Expand All @@ -17,6 +17,7 @@
"notes",
"notetaking",
"tagging",
"backlinks",
"wiki links"
],
"categories": [
Expand Down
10 changes: 8 additions & 2 deletions test/sub/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

---

`⌥F12` (`cmd+k cmd+k`) / Peek Definition / `editor.action.peekDefinition`
**Backlinks Panel**

- to preview Wiki Link inline [[sub.md]] [[test]]
View and navigate backlinks with an Explorer Panel.

---

Expand All @@ -20,6 +20,12 @@

---

`⌥F12` (`cmd+k cmd+k`) / Peek Definition / `editor.action.peekDefinition`

- to preview Wiki Link inline [[sub.md]] [[test]]

---

`⌥F12` (`cmd+k cmd+n`) / Peek References / `editor.action.peekDefinition`

- for Wiki Link [[sub.md]] [[test]]
Expand Down

0 comments on commit b1024e8

Please sign in to comment.