The version identifier VS Code extension
This extension for VS Code helps you to identify Liquid-syntax tags used to apply versioning in the Markdown files for GitHub documentation.
Here's an example of versioning in GitHub Markdown:
Where there's lots of versioning in a Markdown file, especially where versioning is nested within other versioned blocks, it can be difficult to be absolutely sure, just by looking at the Markdown, which version of the docs a particular bit of text will, or will not, appear in. And if you want to remove some versioning it can be hard to know which tags you need to delete. This extension makes things a lot easier.
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.
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:
Alternatively, go to the Command Palette (Ctrl+Shift+p (Windows/Linux) or Shift+command+p (Mac)), type
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.
You can change the settings for the tag highlighting and the keyboard shortcuts you use to run the extension.
Tag highlighting colors
The extension uses an array of color pairs (that is, the background color and the color of the text) to highlight the version tags. You can change the colors by editing the
To change the highlighing colors:
To change the default keyboard shortcuts:
The new shortcut is immediately available for use.
How the extension was coded
For a description of how the Typescript code behind this extension works, see the code-description.md file.
For details of the changes in each release, See the CHANGELOG.md file.