Upstream/waveterm
1
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2025-02-01 23:21:59 +01:00
Code Issues Packages Projects Releases Wiki Activity

Final workspace doc icon fix, use inline custom icon (#1485)

Browse Source
This commit is contained in:
Evan Simkowitz 2024-12-11 10:08:04 -08:00 committed by GitHub
parent 8dbdb4425f
commit ed17c76ada
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/workspaces.mdx
View File

@ -4,8 +4,6 @@ id: "workspaces"
title: "Workspaces"
---
import WorkspaceSVG from "@site/static/img/workspace.svg";
# Workspaces
Workspaces are a powerful way to organize your workflows into separate environments, which you can tailor and optimize.
@ -18,7 +16,7 @@ The primary mechanism to interact with workspaces is via the Workspace Switcher,
This is where you can create a new workspace, edit how a workspace entry appears, and delete a workspace.
The Workspace Switcher button changes to display the icon and color of the active workspace. If the current workspace is not saved, it will display the <WorkspaceSVG/> icon. Clicking the button will open the Workspace Switcher.
The Workspace Switcher button changes to display the icon and color of the active workspace. If the current workspace is not saved, it will display the <i className="custom-icon-inline custom-icon-workspace"/> icon. Clicking the button will open the Workspace Switcher.
The Switcher contains a list of all saved workspaces for your installation, each with a customizable icon, icon color, and name.
@ -46,7 +44,7 @@ The exception to this rule is the last window will be preserved when closed and
To preserve a new workspace, you must save it. This can be acheived by clicking the "Save workspace" button at the bottom of the Workspace Switcher.
If you instead see "Create new workspace" at the bottom of the Workspace Switcher, you are already in a saved workspace. You can also confirm this by checking the wording at the top of the Workspace Switcher. For an unsaved workspace, you will see "Open workspace"; for a saved workspace, you will see "Switch workspaces". You can also confirm this because the icon for the Workspace Switcher button will be <WorkspaceSVG/>.
If you instead see "Create new workspace" at the bottom of the Workspace Switcher, you are already in a saved workspace. You can also confirm this by checking the wording at the top of the Workspace Switcher. For an unsaved workspace, you will see "Open workspace"; for a saved workspace, you will see "Switch workspaces". You can also confirm this because the icon for the Workspace Switcher button will be <i className="custom-icon-inline custom-icon-workspace"/>.
Once a workspace is saved, you will see a new entry in the Workspace Switcher list for your saved workspace. It will be named `New Workspace (<random string>)`. To make the most of your workspace, is recommended to change this name, and the icon and icon color, to something more memorable or meaningful.

14
docs/src/css/custom.css
View File

@ -55,6 +55,14 @@ body .markdown h2 {
background-color: var(--ifm-navbar-link-hover-color);
}
.custom-icon-inline:before {
display: inline-block;
height: 16px;
width: 16px;
background-color: var(--ifm-color-primary-contrast-foreground);
transition: background-color 0.15s linear;
}
.custom-icon-github:before {
content: "";
mask: url(/img/github.svg) no-repeat center / contain;
@ -67,6 +75,12 @@ body .markdown h2 {
-webkit-mask: url(/img/discord.svg) no-repeat center / contain;
}
.custom-icon-workspace:before {
content: "";
mask: url(/img/workspace.svg) no-repeat center / contain;
-webkit-mask: url(/img/workspace.svg) no-repeat center / contain;
}
img[src*="#left"] {
float: left;
margin: 0 10px 10px 0;