Skip to content

Commit 5b72597

Browse files
committed
Add vsix file
1 parent 3781229 commit 5b72597

15 files changed

+61
-1595
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@ dist/
1212

1313
# macOS files
1414
.DS_Store
15+
16+
# Backups
17+
src-BAK/

README.md

Lines changed: 42 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,48 @@ TODO: ADD A SCREENSHOT
2626

2727
## Extension Settings
2828

29-
TODO......
30-
31-
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
32-
33-
For example:
34-
35-
This extension contributes the following settings:
36-
37-
* `myExtension.enable`: Enable/disable this extension.
38-
* `myExtension.thing`: Set to `blah` to do something.
29+
You can change the settings for the tag highlighting and the keyboard shortcuts to run the extension.
30+
31+
### Tag highlighting colors
32+
33+
The extension uses an array of color pairs (background color and the color of the text) to highlight the version tags. You can change the colors by editing the `versionIdentifier.colors` setting in your `settings.json` file.
34+
35+
To change the highlighing colors:
36+
37+
1. Open the VS Code settings editor (<kbd>Ctrl</kbd>+<kbd>,</kbd> (Windows/Linux) or <kbd>command</kbd>+<kbd>,</kbd> (Mac)).
38+
1. Search for `version`.
39+
1. Under "Version-identifier: Color Pairs", click **Edit in settings.json**.
40+
1. Change the colors in the `versionIdentifier.colors` array as required. For example:
41+
42+
```json
43+
"version-identifier.colorPairs": [
44+
{
45+
"backgroundColor": "orange",
46+
"color": "blue"
47+
},
48+
{
49+
"backgroundColor": "yellow",
50+
"color": "red"
51+
},
52+
{
53+
"backgroundColor": "green",
54+
"color": "black"
55+
}
56+
]
57+
```
58+
59+
### Keyboard shortcuts
60+
61+
To change the default keyboard shortcuts:
62+
63+
1. Open the command palette (<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>p</kbd> (Windows/Linux) or <kbd>Shift</kbd>+<kbd>command</kbd>+<kbd>p</kbd> (Mac)).
64+
1. Search for `shortcut`.
65+
1. Select **Preferences: Open Keyboard Shortcuts** (note: not **Preferences: Open Keyboard Shortcuts (JSON)**).
66+
1. Search for `versioning`.
67+
1. Hover over **Versioning identification (Toast)** or **Versioning identification (Modal)** and click the pencil icon to the left of the command name.
68+
1. Press the key combination you want to use for the command, then press Enter.
69+
70+
The new shortcut is immediately available for use.
3971

4072
## Known Issues
4173

dist/extension.js

Lines changed: 0 additions & 1 deletion
This file was deleted.

dist/extension.js.map

Lines changed: 0 additions & 1 deletion
This file was deleted.

package.json

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
{
22
"name": "version-identifier",
33
"displayName": "Versioning Identifier extension",
4-
"description": "This is just for testing a VS Code extension written in TypeScript.",
4+
"description": "Highlight the Liquid versioning that applies at any point within a Markdown file.",
5+
"icon": "images/versioning-identifier-logo-128px.png",
56
"version": "1.0.0",
7+
"publisher": "AlistairChristie",
8+
"license": "See the LICENSE file",
9+
"keywords": [
10+
"versioning",
11+
"liquid",
12+
"markdown",
13+
"tags",
14+
"github"
15+
],
616
"repository": {
717
"type": "git",
818
"url": "https://github.com/docs/version-identifier.git"

src-BAK/extension-BAK-20240113.ts

Lines changed: 0 additions & 269 deletions
This file was deleted.

0 commit comments

Comments
 (0)