docs: move screenshots to repo

hverlin · Dec 11, 2024 · 3ef0a95 · 3ef0a95
1 parent a1d6714
commit 3ef0a95
Show file tree

Hide file tree

Showing 21 changed files with 29 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/hverlin.mise-vscode)](https://marketplace.visualstudio.com/items?itemName=hverlin.mise-vscode)
 [![Open VSX](https://img.shields.io/open-vsx/v/hverlin/mise-vscode)](https://open-vsx.org/extension/hverlin/mise-vscode)
-[![Documentation](https://img.shields.io/badge/wiki-Documentation-blue)](https://github.com/hverlin/mise-vscode/wiki)
+[![Documentation](https://img.shields.io/badge/wiki-Documentation-blue)](https://hverlin.github.io/mise-vscode/tools/)
 
 VS Code extension for [mise](https://mise.jdx.dev/)
 
@@ -50,7 +50,7 @@ to use tools provided by `mise` in your current project.
 - 📱 Show tools which are not installed or active
 - 📦 Install/Remove/Use tools directly from the sidebar
 - 🔧 Configure your other VSCode extensions to use tools provided by `mise`
-  ([list of supported extensions](https://github.com/hverlin/mise-vscode/wiki/Supported-extensions))
+  ([list of supported extensions](https://hverlin.github.io/mise-vscode/reference/supported-extensions/))
 
 ### Environment Variables
 
@@ -69,20 +69,21 @@ This extension lets
 tasks. You can use `mise` tasks in your `launch.json` file.
 
 See the
-[VSCode task integration wiki page](https://github.com/hverlin/mise-vscode/wiki/Tasks#vscode-task-integration)
+[VSCode task integration wiki page](https://hverlin.github.io/mise-vscode/tasks/#vscode-task-integration)
 for more information.
 
 ## Documentation
 
-https://github.com/hverlin/mise-vscode/wiki
+https://hverlin.github.io/mise-vscode/tools/
 
-- [Getting Started](https://github.com/hverlin/mise-vscode/wiki/Getting-Started)
-- [mise.toml language support](https://github.com/hverlin/mise-vscode/wiki/mise.toml-language-support)
-- [Tasks](https://github.com/hverlin/mise-vscode/wiki/Tasks)
-- [Tools](https://github.com/hverlin/mise-vscode/wiki/Tools)
-- [Environment variables](https://github.com/hverlin/mise-vscode/wiki/Environment-variables)
-- [Supported extensions](https://github.com/hverlin/mise-vscode/wiki/Supported-extensions)
-- [Settings](https://github.com/hverlin/mise-vscode/wiki/Settings)
+- [Getting Started](https://hverlin.github.io/mise-vscode/getting-started/)
+- [Tools](https://hverlin.github.io/mise-vscode/tools/)
+- [Environment variables](https://hverlin.github.io/mise-vscode/environment-variables/)
+- [Tasks](https://hverlin.github.io/mise-vscode/tasks/)
+- [mise.toml language support](https://hverlin.github.io/mise-vscode/misetoml-language-support/)
+- Reference
+  - [Supported extensions](https://hverlin.github.io/mise-vscode/reference/supported-extensions/)
+  - [Extension Settings](https://hverlin.github.io/mise-vscode/reference/settings/)
 
 ## Bug Reports / Feature Requests / Contributing
 

diff --git a/docs/src/assets/create-file-task.png b/docs/src/assets/create-file-task.png
diff --git a/docs/src/assets/env-1.png b/docs/src/assets/env-1.png
diff --git a/docs/src/assets/env-terminal-settings.png b/docs/src/assets/env-terminal-settings.png
diff --git a/docs/src/assets/env-terminal-warning.png b/docs/src/assets/env-terminal-warning.png
diff --git a/docs/src/assets/env-terminal.png b/docs/src/assets/env-terminal.png
diff --git a/docs/src/assets/mise-menu.png b/docs/src/assets/mise-menu.png
diff --git a/docs/src/assets/mise-toml-language-support.png b/docs/src/assets/mise-toml-language-support.png
diff --git a/docs/src/assets/task-activity-bar.png b/docs/src/assets/task-activity-bar.png
diff --git a/docs/src/assets/task-code-lens.png b/docs/src/assets/task-code-lens.png
diff --git a/docs/src/assets/task-run-activity-bar.png b/docs/src/assets/task-run-activity-bar.png
diff --git a/docs/src/assets/tasks-command-palette.png b/docs/src/assets/tasks-command-palette.png
diff --git a/docs/src/assets/tools-activity-bar.png b/docs/src/assets/tools-activity-bar.png
diff --git a/docs/src/assets/tools-decoration.png b/docs/src/assets/tools-decoration.png
diff --git a/docs/src/assets/tools-list.png b/docs/src/assets/tools-list.png
diff --git a/docs/src/content/docs/Environment-variables.md b/docs/src/content/docs/Environment-variables.md
@@ -10,7 +10,7 @@ sidebar:
 Environment variables are listed in the activity bar. Click on an environment
 variable to find where it's defined.
 
-![image](https://github.com/user-attachments/assets/6c11cc6f-c7b9-4608-8ad3-701fc1d7566f)
+![env-list.png](../../assets/env-1.png)
 
 ## Loading environment variables
 
@@ -21,16 +21,16 @@ extension.
 The variables will be provided to any newly created terminals, even if `mise` is
 not activated.
 
-![image](https://github.com/user-attachments/assets/6abe2397-05ea-4a73-a3b6-4f12406f9bec)
+![env-terminal.png](../../assets/env-terminal.png)
 
 If the list of environment variables has changed, you might to reload the
 terminal. In this case, a warning sign will be shown next to the terminal name.
 
-![image](https://github.com/user-attachments/assets/cc905263-2b3f-4a5b-8ce9-988fbb8c8e79)
+![env-terminal-warning.png](../../assets/env-terminal-warning.png)
 
 You can choose to reload open terminals automatically in the
 [settings](vscode://settings/mise.updateOpenTerminalsEnvAutomatically) (off by
 default). If `mise` is activated in your terminal, it's better to keep this
 option turned off.
 
-![image](https://github.com/user-attachments/assets/54c1cd26-9859-47ce-aa95-d835818a56df)
+![env-terminal-settings.png](../../assets/env-terminal-settings.png)
diff --git a/docs/src/content/docs/Getting-Started.mdx b/docs/src/content/docs/Getting-Started.mdx
@@ -22,4 +22,4 @@ The extension should now be activated. You can access the features using:
      `Open Tool definition` or `Open Mise Task definition`
    - The status bar at the bottom of the window
 
-![image](https://github.com/user-attachments/assets/9d7b98c6-a55d-47ab-8f95-75639c1590a5)
+![]( ../../../../screenshots/mise-extension.png)
diff --git a/docs/src/content/docs/Tasks.md b/docs/src/content/docs/Tasks.md
@@ -9,7 +9,8 @@ sidebar:
 
 ### Using the mise activity bar
 
-![image](https://github.com/user-attachments/assets/6c4243fb-4cd4-4296-a16d-9cdf31acf32e)
+![task-activity-bar.png](../../assets/task-activity-bar.png)
+
 Click on a task to navigate to the file where the task is defined.
 
 ### Using the command palette
@@ -23,22 +24,23 @@ You have several ways to run a task with the extension:
 
 ### Use the run task code lens action
 
-![image](https://github.com/user-attachments/assets/f10db1fd-6e4e-4cc3-b0ff-a81d78a524e3)
+![task-code-lens.png](../../assets/task-code-lens.png)
 
 Click on the run button to run the task. If some option/arguments are required,
 you will be prompted to enter them.
 
 ### Use the mise activity bar
 
-![image](https://github.com/user-attachments/assets/603f1c05-78eb-44a3-b9b8-8dfe380d1810)
+![task-run-activity-bar.png](../../assets/task-run-activity-bar.png)
+
 Click on the run action, or use right-click -> run task
 
 ### Use the command palette
 
 Using the command palette: `cmd|ctrl+shift+p`, search for `Mise: run task`.
 Press enter.
 
-![image](https://github.com/user-attachments/assets/28e67c2b-c1fe-492c-a06d-078d1ab001bf)
+![img.png](../../assets/tasks-command-palette.png)
 
 ### VSCode task integration
 
@@ -79,7 +81,7 @@ create your own shortcuts to run tasks
 
 You can create a file task or a toml task directly from the activity bar
 
-![image](https://github.com/user-attachments/assets/58cd931f-724a-4e09-ad8a-89c039154ac5)
+![create-file-task.png](../../assets/create-file-task.png)
 
 ### Use the command palette
 

diff --git a/docs/src/content/docs/Tools.md b/docs/src/content/docs/Tools.md
@@ -10,7 +10,7 @@ sidebar:
 The extension will show the currently installed tool versions directly in the
 editor
 
-![image](https://github.com/user-attachments/assets/24b00737-8fcf-4d01-a2b4-37b34909c262)
+![tools-decoration.png](../../assets/tools-decoration.png)
 
 ## Tool explorer (activity bar)
 
@@ -21,7 +21,7 @@ in the current project. You can also the list of global tools.
 - Some additional options are available on right-click, like copying the
   bin/install path or removing the tool
 
-![image](https://github.com/user-attachments/assets/d641bc9b-13ca-487f-8e88-8cfe1df789be)
+![img.png](../../assets/tools-activity-bar.png)
 
 ## Tools list
 
@@ -30,4 +30,4 @@ Use the list `List all tools` button to list all installed tools.
 - You can filter the tools used in the current project using `active` only.
 - From there, you can upgrade, uninstall or prune unused tools
 
-![image](https://github.com/user-attachments/assets/1ea60303-2f3e-4e9f-84f0-38647d5a93fa)
+![tools-list.png](../../assets/tools-list.png)
diff --git a/docs/src/content/docs/mise.toml-language-support.md b/docs/src/content/docs/mise.toml-language-support.md
@@ -14,7 +14,7 @@ TOML files.
 `mise-vscode` provides syntax highlighting for `tera` used for
 [templating](https://mise.jdx.dev/templates.html) in `mise.toml` files
 
-![image](https://github.com/user-attachments/assets/8654329a-1f8d-4d06-98af-064c8e4c622d)
+![mise-toml-language-support.png](../../assets/mise-toml-language-support.png)
 
 ### Code completion
 

diff --git a/docs/src/content/docs/reference/Settings.md b/docs/src/content/docs/reference/Settings.md
@@ -15,7 +15,7 @@ access the settings:
 You can also click on the mise extension indicator in the status bar to quickly
 access the extension settings.
 
-<img width="1414" alt="picture showing mise extension settings" src="https://github.com/user-attachments/assets/1572f0e8-98b2-4f05-a21f-de77ee020f73">
+![picture showing mise extension settings](../../../assets/mise-menu.png)
 
 ## `mise.enable`