docs(vsc): improve readme for vsc marketplace

nvlang · Jun 30, 2024 · d518bba · d518bba
1 parent ec7373f
commit d518bba
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/extras/vscode-extension/CHANGELOG.md b/extras/vscode-extension/CHANGELOG.md
@@ -2,6 +2,12 @@
 
 ## [1.0.0] - 2024-06-30
 
-### Added
+### Features
 
-- Added basic support for SvelTeX syntax highlighting.
+-   Added basic support for SvelTeX syntax highlighting.
+
+## [1.0.1] - 2024-06-30
+
+### Documentation
+
+-   Improved `README.md` for rendering on the VS Code Marketplace.
diff --git a/extras/vscode-extension/README.md b/extras/vscode-extension/README.md
@@ -13,7 +13,7 @@ preprocessor for Svelte that aims to combine markdown, Svelte, and (some) LaTeX.
 -   `<script>` languages: JavaScript, TypeScript
 -   `<style>` languages: CSS, SCSS, SASS, PostCSS, Stylus
 
-![screenshot](res/screenshot-ayu-dark-bordered.png)
+![screenshot](https://raw.githubusercontent.com/nvlang/sveltex/main/extras/vscode-extension/res/screenshot-ayu-dark-bordered.png)
 
 ## Requirements
 
@@ -33,8 +33,7 @@ This extension contributes the following settings:
     contents of these tags are highlighted the same way as a plaintext fenced
     code block would in markdown.
 
-> [!NOTE]
-> You might need to reload the window for the changes to take effect.
+⚠ **Note:** You might need to reload the window for the changes to take effect.
 
 ## Limitations
 
@@ -54,5 +53,11 @@ This extension contributes the following settings:
 
 Initial release.
 
+### 1.0.1
+
+#### Documentation
+
+-   Improved `README.md` for rendering on the VS Code Marketplace.
+
 
 [SvelTeX]: https://sveltex.dev/
diff --git a/extras/vscode-extension/package.json b/extras/vscode-extension/package.json
@@ -2,7 +2,7 @@
   "name": "sveltex",
   "displayName": "SvelTeX",
   "description": "Svelte + Markdown + LaTeX",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "homepage": "https://sveltex.dev/",
   "keywords": [
     "sveltex",