Merge pull request #24 from dons20/develop

Published Version v1.4.4
dons20 · Nov 30, 2020 · dd31db2 · dd31db2
2 parents 41041fd + 94e601b
commit dd31db2
Show file tree

Hide file tree

Showing 8 changed files with 856 additions and 824 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,13 +1,21 @@
+<!-- IMPORTANT! -->
+<!-- Everything between these tags are comments -->
+<!-- They will help to guide you with creating a proper issue and receive a quicker resolution to your issue -->
+
 <!-- BUG REPORT TEMPLATE -->
 <!-- 
     Please double check the checklist below, and 
     place an 'x' inside each box that you've confirmed before submitting. 
+    Do not put any spaces inside the box if you've put an 'x' inside it.
+    If 
     e.g. [x] Check that you are running the latest version of Visual Studio Code
+
+    At any time, click the Preview Tab to view a realtime preview of your issue.
 -->
 
 - [ ] Check that you are running the latest version of Visual Studio Code
-- [ ] Check that you are running the latest version of the snippet plugin (UIkit 3.0 Snippets 1.4.0)
-- [ ] Check that the extension is enabled
+- [ ] Check that you are running the latest version of the `UIKit 3.0 Snippets` plugin: (1.4.3)
+- [ ] Check that the `UIKit 3.0 Snippets` extension is enabled
 - [ ] Check that your editor suggestions are enabled (or manually trigger them with <kbd>Ctrl</kbd> + <kbd>Space</kbd>
 
 ### Problem Encountered
@@ -19,4 +27,3 @@
 1. Step 1 ...
 2. Step 2 ...
 
-<!-- FEATURE REQUEST TEMPLATE -->
diff --git a/.github/README.md b/.github/README.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+# Version 1.4.4 (November 29, 2020)
+
+🎄 Thank you all for 20K+ downloads, Happy Holidays, and stay safe ♥
+
+* 💡 Updated to UIkit 3.5.9
+
+* 💡 Updated some broken/outdated links, and created a better preview GIF
+
+* ✅ Added `uk-text-default`
+
 # Version 1.4.3 (June 14, 2020)
 
 ## Contributions

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,26 +1,35 @@
 Contribution Guidelines
 ---
 1. Clone this repo
-2. All the snippets are located inside of `/snippets/snippets.json`.
-3. a. For new entries, copy the snippet syntax below (or an existing one for simplicity)
+2. All the snippets are located inside of the `/snippets/` folder. 
+
+    - `javascript.json` for Javascript related snippets
+    - `snippets.code-snippets` for all other snippets
+
+3. How to modify:
+
+    a. For new entries, copy the snippet syntax below (or an existing one for simplicity)
 
    b. For existing entries, simply search the list `Ctrl+F`, and modify as you like.
 
-4. Send me a Pull Request
+4. Submit a [pull request](https://github.com/dons20/UIKit-VSCode/pulls) to the repository.
 
 #### Snippet Template
 
 ```json
 "snippet-uk-PREFIX": {
     "prefix": "uk-PREFIX",
-    "body": [ 	"HTML HERE",
-                "Multiple Lines Seperated with double quotes and a comma",
-                "Last Line does not have a comma"
-            ],
+    "body": [ 	
+        "HTML HERE",
+        "Multiple Lines Seperated with double quotes and a comma",
+            "\t Lines that start with the tab character, can be visually tabbed for better readability, but its not required",
+        "Set tab locations with $0 - any number you specify, with $0 automatically being the last tab location",
+        "Last Line does not have a comma"
+    ],
     "description": "Enter your description here"
 }, 
 ```
-Be sure to modify the list of commands in `README.md` with your changes as well!
+If applicable, please update the list of commands in `README.md` with your changes if you added or renamed a snippet.
 
 Snippet Modification Tips
 ---
@@ -35,16 +44,18 @@ First, [check out Microsoft's offical documentation on snippets](https://code.vi
 
 HTML code needs to have proper indentation to be human readable, so use the `\t` modifier in front of a string in the `"body"` to tab it in. You can combine multiple `\t` characters to properly indent the code as you like.
 
-Take this example below:
+Take the body portion of a snippet example below:
 
 ```json
+{
     ...
-    "body": [   "<html>",
-                    "\t<body>",
-                    "\t</body>",
-                "</html>"
+    "body": [   
+        "<html>",
+            "\t<body>",
+            "\t</body>",
+        "</html>"
     ],
-    ...
+}
 ```
 
 When inserted into a document, it would be displayed as:
@@ -59,33 +70,31 @@ When inserted into a document, it would be displayed as:
 #### Testing Changes:
 
 1. Press `F1` in Visual Studio Code
-2. Click on "Preferences: Open User Snippets"
+2. Click on "Preferences: Configure User Snippets"
 3. Click on HTML
 4. Copy the contents of `html.json` from the existing project, to your user snippets.
-5. Create a local `.html` file to test it in.
+5. Create a local `html` file to test it in... e.g. `test.html`
 6. Start typing in the command you wish to test.
 
 #### Tab Locations
 
 When a user enters a snippet, you may want to add some placeholder content for them to modify with ease, simply by pressing tab to cycle through them. The official documentation covers this more, but here are two simple examples.
 
-You can have a user tab through locations in order from 1-anything, but 0 is the final stop for the tab.
+You can have a user tab through locations in order from 1 to any number, but `0` is the final stop for the tab.
 ```json
-    ...
-    "body": [   "<h1>$1</h1>",
-                "<p>$2</p>",
-                "<p>$0</p>"
-    ],
-    ...
+"body": [   
+    "<h1>$1</h1>",
+    "<p>$2</p>",
+    "<p>$0</p>"
+],
 ```
 
 You can also have placeholder content that is automatically highlighted when the user tabs to it.
 
 ```json
-    ...
-    "body": [   "<h1>${1:Sample header}</h1>",
-                "<p>${2:Paragraph 1}</p>",
-                "<p>${0:Final Stop}</p>"
-    ],
-    ...
+"body": [   
+    "<h1>${1:Sample header}</h1>",
+    "<p>${2:Paragraph 1}</p>",
+    "<p>${0:Final Stop}</p>"
+],
 ```
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Installs](https://vsmarketplacebadge.apphb.com/installs/Keno.uikit-3-snippets.svg)](https://marketplace.visualstudio.com/items?itemName=Keno.uikit-3-snippets)
 [![Rating](https://vsmarketplacebadge.apphb.com/rating/Keno.uikit-3-snippets.svg)](https://marketplace.visualstudio.com/items?itemName=Keno.uikit-3-snippets)
 
-[![Demo Image](https://zippy.gfycat.com/AmusingGiftedJumpingbean.gif)](https://gfycat.com/AmusingGiftedJumpingbean)
+[![Demo Image](https://thumbs.gfycat.com/WeakRemorsefulHornshark-size_restricted.gif)](https://gfycat.com/weakremorsefulhornshark)
 
 ## [🌞 View the Changelog](https://marketplace.visualstudio.com/items/Keno.uikit-3-snippets/changelog) to see what's new!
 ---

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
     "displayName": "UIkit 3.0 Snippets",
     "publisher": "Keno",
     "description": "UIkit 3.0 Snippets based on official documentation",
-    "version": "1.4.3",
+    "version": "1.4.4",
     "license": "SEE LICENSE IN LICENSE.md",
     "icon": "images/icon.png",
     "galleryBanner": {