diff --git a/CHANGELOG.md b/CHANGELOG.md index ac7aadb..3acfe1e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Change Log +## 1.0.3 +24 January 2024 + +- Clarify the keybindings in the README. + +## 1.0.2 +24 January 2024 + +- Fixed the keybindings for Windows. These are now `alt + j` for the toast popup and `shift + alt + j` for the modal popup. + ## 1.0.1 16 January 2024 diff --git a/README.md b/README.md index 2b0f2a7..608046d 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,19 @@ The extension does two things, it: There are options for how you want the message to be displayed. You can show the usual popup "toast" message at the bottom right of VS Code, which disappears after a while. Alternatively, you can display a modal popup, which you have to click to dismiss. -To use the extension, either: -- Use a keypress: - - For the "toast" message, press Ctrl+Alt+v (Windows/Linux) or control+command+v (Mac) - - For the modal popup, press Shift+Ctrl+Alt+v (Windows/Linux) or Shift+control+command+v (Mac) -- Go to the Command Palette (Ctrl+Shift+p (Windows/Linux) or Shift+command+p (Mac)), type `version` and select either **Versioning identification (Toast)** or **Versioning identification (Modal)**. +## Using the extension + +In a Markdown file that contains Liquid version tags, place the cursor in the text for which you want to identify the versioning, then: + +- To see the versioning in a "toast" popup, click: + - control+command+v on MacOS + - alt+j on Windows + +- To see the versioning in a modal dialog, click: + - shift+control+command+v on MacOS + - shift+alt+j on Windows + +Alternatively, go to the Command Palette (Ctrl+Shift+p (Windows/Linux) or Shift+command+p (Mac)), type `version` and select either **Versioning identification (Toast)** or **Versioning identification (Modal)**. The extension highlights each set of tags that affects the current cursor position in a different color. In this example, the cursor is in the word "series" on line 112. The text at that point is within a set of tags that's nested within another tag set, that's also nested. So three sets of tags are highlighted. The "toast" popup describes the versioning. diff --git a/package-new.json b/package-new.json deleted file mode 100644 index c25bd6a..0000000 --- a/package-new.json +++ /dev/null @@ -1,109 +0,0 @@ -{ - "name": "version-identifier", - "displayName": "Versioning Identifier", - "description": "Highlight the Liquid versioning that applies at any point within a Markdown file.", - "icon": "images/versioning-identifier-logo-128px.png", - "version": "1.0.1", - "publisher": "AlistairChristie", - "license": "See the LICENSE file", - "keywords": [ - "versioning", - "liquid", - "markdown", - "tags", - "github" - ], - "repository": { - "type": "git", - "url": "https://github.com/docs/version-identifier.git" - }, - "engines": { - "vscode": "^1.85.0" - }, - "categories": [ - "Other" - ], - "activationEvents": [], - "main": "./dist/extension.js", - "contributes": { - "commands": [ - { - "command": "version-identifier.runExtensionModal", - "title": "Versioning identification (Modal)" - }, - { - "command": "version-identifier.runExtensionToast", - "title": "Versioning identification (Toast)" - } - ], - "keybindings": [ - { - "key": "escape", - "command": "version-identifier.removeDecorations", - "when": "editorTextFocus" - } - ], - "configuration": { - "type": "object", - "title": "Versioning Extension Configuration", - "properties": { - "version-identifier.colorPairs": { - "type": "array", - "default": [ - { - "backgroundColor": "darkred", - "color": "white" - }, - { - "backgroundColor": "darkblue", - "color": "yellow" - }, - { - "backgroundColor": "green", - "color": "black" - } - ], - "description": "Color pairs", - "items": { - "type": "object", - "properties": { - "backgroundColor": { - "type": "string" - }, - "color": { - "type": "string" - } - } - } - } - } - } - }, - "scripts": { - "vscode:prepublish": "npm run package", - "compile": "webpack", - "watch": "webpack --watch", - "package": "webpack --mode production --devtool hidden-source-map", - "compile-tests": "tsc -p . --outDir out", - "watch-tests": "tsc -p . -w --outDir out", - "pretest": "npm run compile-tests && npm run compile && npm run lint", - "lint": "eslint src --ext ts", - "test": "vscode-test" - }, - "devDependencies": { - "@types/mocha": "^10.0.6", - "@types/node": "18.x", - "@types/vscode": "^1.85.0", - "@typescript-eslint/eslint-plugin": "^6.13.1", - "@typescript-eslint/parser": "^6.13.1", - "@vscode/test-cli": "^0.0.4", - "@vscode/test-electron": "^2.3.8", - "eslint": "^8.54.0", - "ts-loader": "^9.5.1", - "typescript": "^5.3.2", - "webpack": "^5.89.0", - "webpack-cli": "^5.1.4" - }, - "dependencies": { - } -} diff --git a/package.json b/package.json index 33e677c..adfc24a 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "displayName": "Versioning Identifier", "description": "Highlight the Liquid versioning that applies at any point within a Markdown file.", "icon": "images/versioning-identifier-logo-128px.png", - "version": "1.0.1", + "version": "1.0.3", "publisher": "AlistairChristie", "license": "See the LICENSE file", "keywords": [ @@ -39,13 +39,13 @@ "keybindings": [ { "command": "version-identifier.runExtensionToast", - "key": "ctrl+cmd+v", + "key": "alt+j", "mac": "ctrl+cmd+v", "when": "editorTextFocus" }, { "command": "version-identifier.runExtensionModal", - "key": "shift+ctrl+cmd+v", + "key": "shift+alt+j", "mac": "shift+ctrl+cmd+v", "when": "editorTextFocus" }, diff --git a/version-identifier-1.0.2.vsix b/version-identifier-1.0.2.vsix new file mode 100644 index 0000000..b69a67e Binary files /dev/null and b/version-identifier-1.0.2.vsix differ diff --git a/version-identifier-1.0.3.vsix b/version-identifier-1.0.3.vsix new file mode 100644 index 0000000..6adc043 Binary files /dev/null and b/version-identifier-1.0.3.vsix differ