Skip to content

Commit 93442e3

Browse files
docs: add editor images
1 parent bc068b7 commit 93442e3

File tree

6 files changed

+18
-12
lines changed

6 files changed

+18
-12
lines changed
Loading
Loading
Loading
Loading
Loading

docs/tutorialkit.dev/src/content/docs/reference/theming.mdx

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ import themingPanelHeader from './images/theming-panel-header.png';
99
import themingFiletree from './images/theming-filetree.png';
1010
import themingFiletreeFile from './images/theming-filetree-file.png';
1111
import themingFileTreeFolder from './images/theming-filetree-folder.png';
12+
import themingEditorGutter from './images/theming-editor-gutter.png';
13+
import themingEditorFoldGutter from './images/theming-editor-gutter-fold.png';
14+
import themingEditorTooltip from './images/theming-editor-tooltip.png';
1215

1316
TutorialKit allows you to customize its appearance to match your brand or preferences. This guide explains how to modify various elements of the interface using CSS variables and file replacements.
1417

@@ -382,21 +385,16 @@ The previews can show one or multiple websites.
382385

383386
The editor is an important part of TutorialKit as it allows you to write and edit code.
384387

385-
| Token | Description |
386-
| ----------------------------------------------------- | ------------------------------------------------------------ |
387-
| `--tk-elements-editor-textColor` | The text color of the editor. |
388-
| `--tk-elements-editor-backgroundColor` | The background color of the editor. |
389-
| `--tk-elements-editor-activeLineBackgroundColor` | The background color of the active line in the editor. |
390-
| `--tk-elements-editor-cursorColor` | The color of the cursor. |
391-
| `--tk-elements-editor-matchingBracketBackgroundColor` | The background color of the matching bracket. |
392-
| `--tk-elements-editor-panels-borderColor` | The border color between different panels inside the editor. |
393-
394-
#### Selection
395-
396-
Text selections inside the editor can be styled with the following tokens:
388+
![Editor](./images/theming-editor.png)
397389

398390
| Token | Description |
399391
| ---------------------------------------------------------- | --------------------------------------------------------------- |
392+
| `--tk-elements-editor-textColor` | The text color of the editor. |
393+
| `--tk-elements-editor-backgroundColor` | The background color of the editor. |
394+
| `--tk-elements-editor-activeLineBackgroundColor` | The background color of the active line in the editor. |
395+
| `--tk-elements-editor-cursorColor` | The color of the cursor. |
396+
| `--tk-elements-editor-matchingBracketBackgroundColor` | The background color of the matching bracket. |
397+
| `--tk-elements-editor-panels-borderColor` | The border color between different panels inside the editor. |
400398
| `--tk-elements-editor-selection-backgroundColor` | The background color of selected text in the editor. |
401399
| `--tk-elements-editor-selection-backgroundOpacity` | The background opacity of selected text in the editor. |
402400
| `--tk-elements-editor-selection-inactiveBackgroundColor` | The background color of inactive selected text in the editor. |
@@ -406,6 +404,8 @@ Text selections inside the editor can be styled with the following tokens:
406404

407405
The gutter refers to the area on the left side of the editor that shows line numbers and other information.
408406

407+
<Image src={themingEditorGutter} alt="Editor Gutter" width="65" densities={[2]} />
408+
409409
| Token | Description |
410410
| ------------------------------------------------- | ------------------------------------------------ |
411411
| `--tk-elements-editor-gutter-textColor` | The text color of the gutter. |
@@ -416,6 +416,8 @@ The gutter refers to the area on the left side of the editor that shows line num
416416

417417
The fold gutter is part of the gutter, and is the area next to it that shows the folding icons.
418418

419+
<Image src={themingEditorFoldGutter} alt="Editor Fold Gutter" width="28" densities={[2]} />
420+
419421
| Token | Description |
420422
| ------------------------------------------------ | ---------------------------------------------------------------------------- |
421423
| `--tk-elements-editor-foldGutter-textColor` | The text color of the fold gutter. |
@@ -425,6 +427,8 @@ The fold gutter is part of the gutter, and is the area next to it that shows the
425427

426428
The search panel is the panel that shows up when you search text in the editor.
427429

430+
![Editor Search](./images/theming-editor-search.png)
431+
428432
| Token | Description |
429433
| -------------------------------------------------------------- | --------------------------------------------------------------------------- |
430434
| `--tk-elements-editor-search-textColor` | The text color of the search panel. |
@@ -448,6 +452,8 @@ The search panel is the panel that shows up when you search text in the editor.
448452

449453
The tooltip is the small popup that shows up when you hover over an item or when the editor shows suggestions when autocompleting code.
450454

455+
<Image src={themingEditorTooltip} alt="Editor Tooltip" width="336" densities={[2]} />
456+
451457
| Token | Description |
452458
| ------------------------------------------------------ | --------------------------------------------------------- |
453459
| `--tk-elements-editor-tooltip-textColor` | The text color of the tooltip. |

0 commit comments

Comments
 (0)