You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is the README for your extension "my-test-extension". After writing up a brief description, we recommend including the following sections.
3
+
This extension for VS Code helps you to identify Liquid-syntax tags used to apply versioning in the Markdown files for GitHub documentation.
4
4
5
-
## Features
5
+
An example of versioning in Markdown is:
6
+
7
+
`This text is not versioned{% ifversion ghes > 3.10 %}, but this only appears in the documentation for GitHub Enterprise Server 3.11 or higher{% endif %}.`
6
8
7
-
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
9
+
Where there is lots of versioning in a Markdown file, especially where there is versioning 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.
8
10
9
-
For example if there is an image subfolder under your extension project workspace:
11
+
## Features
10
12
11
-
\!\[feature X\]\(images/feature-x.png\)
13
+
The extension does two things, it:
14
+
- Displays a message describing the versioning at the current cursor position within the Markdown file.
15
+
- Highlights the version tags that affect the versioning at the cursor position.
12
16
13
-
> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow.
17
+
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.
14
18
15
-
## Requirements
19
+
To use the extension, either:
20
+
- Use a keypress:
21
+
- For the "toast" message, press <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>v</kbd> (Windows/Linux) or <kbd>control</kbd>+<kbd>command</kbd>+<kbd>v</kbd> (Mac)
22
+
- For the modal popup, press <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>v</kbd> (Windows/Linux) or <kbd>Shift</kbd>+<kbd>control</kbd>+<kbd>command</kbd>+<kbd>v</kbd> (Mac)
23
+
- Go to 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)), type `version` and select either **Versioning identification (Toast)** or **Versioning identification (Modal)**.
16
24
17
-
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
25
+
TODO: ADD A SCREENSHOT
18
26
19
27
## Extension Settings
20
28
29
+
TODO......
30
+
21
31
Include if your extension adds any VS Code settings through the `contributes.configuration` extension point.
22
32
23
33
For example:
@@ -29,43 +39,8 @@ This extension contributes the following settings:
29
39
30
40
## Known Issues
31
41
32
-
Calling out known issues can help limit users opening duplicate issues against your extension.
42
+
None.
33
43
34
44
## Release Notes
35
45
36
-
Users appreciate release notes as you update your extension.
37
-
38
-
### 1.0.0
39
-
40
-
Initial release of ...
41
-
42
-
### 1.0.1
43
-
44
-
Fixed issue #.
45
-
46
-
### 1.1.0
47
-
48
-
Added features X, Y, and Z.
49
-
50
-
---
51
-
52
-
## Following extension guidelines
53
-
54
-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
0 commit comments