diff --git a/README.md b/README.md new file mode 100644 index 0000000..98b429e --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ +
+

zk-vscode

+

A Visual Studio Code extension for zk

+
Install from the Marketplace
+
+ + +## Description + +[`zk`](https://github.com/mickael-menu/zk) is a command-line tool helping you to maintain a plain text [Zettelkasten](https://zettelkasten.de/introduction/) or [personal wiki](https://en.wikipedia.org/wiki/Personal_wiki). It provides a Language Server to augment LSP-compatible editors with many features such as auto-completion and navigation. + +`zk-vscode` is a Visual Studio Code client extension for `zk`'s Language Server. + +### Highlights + +* Follow note links (including Wiki-links) + +* Complete links ([configure Wiki-links in `zk`'s configuration file](https://github.com/mickael-menu/zk/blob/main/docs/note-format.md)) + + Link completion + +* Complete tags + + Tag completion + +* Preview a note on hover + + Hover + +* Peek a note with "Peek definition" + + Peek note + +## Troubleshooting issues + +If you experience issues with `zk-vscode`, you can peek at the Language Server logs with the **zk: Show Logs** VS Code command. To get more detailed logs, set the verbose mode in your `settings.json`: + +```json +{ + "zk.trace.server": "verbose" +} +``` \ No newline at end of file diff --git a/media/screenshots/hover.png b/media/screenshots/hover.png new file mode 100644 index 0000000..196b851 Binary files /dev/null and b/media/screenshots/hover.png differ diff --git a/media/screenshots/link-completion.png b/media/screenshots/link-completion.png new file mode 100644 index 0000000..2ba4565 Binary files /dev/null and b/media/screenshots/link-completion.png differ diff --git a/media/screenshots/peek.png b/media/screenshots/peek.png new file mode 100644 index 0000000..ab1797f Binary files /dev/null and b/media/screenshots/peek.png differ diff --git a/media/screenshots/tag-completion.png b/media/screenshots/tag-completion.png new file mode 100644 index 0000000..9fd7ae5 Binary files /dev/null and b/media/screenshots/tag-completion.png differ diff --git a/package.json b/package.json index 609d1fd..1ed6b32 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,9 @@ "name": "zk-vscode", "displayName": "zk-vscode", "description": "Visual Studio Code extension for zk", - "version": "0.0.1", + "publisher": "mickael-menu", + "version": "0.1.0", + "repository": { "type": "git", "url": "https://github.com/mickael-menu/zk-vscode.git" }, "engines": { "vscode": "^1.55.0" },