summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDan Davison <dandavison7@gmail.com>2023-04-10 09:28:12 -0400
committerDan Davison <dandavison7@gmail.com>2023-04-10 09:28:12 -0400
commit8fd64868e8ed9a8248d8a29ae4be30920df197cd (patch)
treeb08a6ff3860754985b7389d4c7ee895df66e2073
parentb0374564d666889150bbe1fb351cd02a38a2645e (diff)
Add VSCode documentation
-rw-r--r--manual/src/SUMMARY.md9
-rw-r--r--manual/src/tips-and-tricks/using-delta-with-vscode.md13
2 files changed, 18 insertions, 4 deletions
diff --git a/manual/src/SUMMARY.md b/manual/src/SUMMARY.md
index 232a19f3..21bd8360 100644
--- a/manual/src/SUMMARY.md
+++ b/manual/src/SUMMARY.md
@@ -22,12 +22,13 @@
- [Supported languages and themes](./supported-languages-and-themes.md)
- [Tips & tricks](./tips-and-tricks.md)
- [24 bit color (truecolor)](./tips-and-tricks/24-bit-color-truecolor.md)
- - [Using Delta with tmux](./tips-and-tricks/using-delta-with-tmux.md)
- - [Using Delta with GNU Screen](./tips-and-tricks/using-delta-with-gnu-screen.md)
- - [Using Delta on Windows](./tips-and-tricks/using-delta-on-windows.md)
- [Mouse scrolling](./tips-and-tricks/mouse-scrolling.md)
- - [Using Delta with Magit](./tips-and-tricks/using-delta-with-magit.md)
- [Save output with colors to HTML/PDF etc](./tips-and-tricks/export-to-html.md)
+ - [Using Delta on Windows](./tips-and-tricks/using-delta-on-windows.md)
+ - [Using Delta with GNU Screen](./tips-and-tricks/using-delta-with-gnu-screen.md)
+ - [Using Delta with Magit](./tips-and-tricks/using-delta-with-magit.md)
+ - [Using Delta with tmux](./tips-and-tricks/using-delta-with-tmux.md)
+ - [Using Delta with VSCode](./tips-and-tricks/using-delta-with-vscode.md)
- [Comparisons with other tools](./comparisons-with-other-tools.md)
- [Build delta from source](./build-delta-from-source.md)
- [Related projects](./related-projects.md)
diff --git a/manual/src/tips-and-tricks/using-delta-with-vscode.md b/manual/src/tips-and-tricks/using-delta-with-vscode.md
new file mode 100644
index 00000000..3deafbbb
--- /dev/null
+++ b/manual/src/tips-and-tricks/using-delta-with-vscode.md
@@ -0,0 +1,13 @@
+# Using Delta with VSCode
+
+All Delta features work correctly in VSCode's terminal emulator (please open an issue if that's not true).
+
+To format file links for opening in VSCode from other terminal emulators, use the [VSCode URL handler](https://code.visualstudio.com/docs/editor/command-line#_opening-vs-code-with-urls):
+
+```gitconfig
+[delta]
+ hyperlinks = true
+ hyperlinks-file-link-format = "vscode://file/{path}:{line}"
+```
+
+(To use VSCode Insiders, change that to `vscode-insiders://file/{path}:{line}`).