Skip to content

Commit 33caaa4

Browse files
committed
docs(vscode/diagram-editor): explain plans
1 parent 4d3b2f9 commit 33caaa4

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/vscode/diagram-editor.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Diagram Editor in VS Code
3+
sidebar_label: Diagram Editor
4+
---
5+
6+
# Diagram Editor in VS Code
7+
8+
The visual diagram editor in Wokwi for VS Code allows you to edit the diagram of your simulation project. It is available in the [Hobby+ and Pro plans](https://wokwi.com/pricing).
9+
10+
## Opening the diagram editor
11+
12+
To open the diagram editor, click on a diagram.json file in the Explorer view. The diagram will open in a new tab. The diagram editor also works for files matching the `diagram.*.json` pattern, such as `diagram.esp32.json`. This is useful if you have multiple target boards in your project, and want to maintain a diagram for each target board.
13+
14+
If you are using the Community or the Hobby plan, you will be able to view the diagram, but not edit it in the diagram editor. You can still edit the diagram.json file in the text editor.
15+
16+
## Editing the diagram as text
17+
18+
Some advanced features are only available if you modify the diagram in the text editor. You can open the text editor by right clicking on the diagram.json tab, selecting "Reopen Editor With..." and then selecting "Text Editor".
19+
20+
## Running the simulation
21+
22+
You can run the simulation by pressing the green play button in the top left corner of the editor. Wokwi will open a new tab and start the simulation.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ module.exports = {
8888
'VS Code Extension': [
8989
'vscode/getting-started',
9090
'vscode/project-config',
91+
'vscode/diagram-editor',
9192
'vscode/debugging',
9293
'vscode/offline-mode',
9394
],

0 commit comments

Comments
 (0)