|
1 |
| -#  ZenUML VSCode Extension |
| 1 | +#  ZenUML VSCode Extension |
| 2 | + |
2 | 3 | The ZenUML VSCode Extension is a powerful tool that allows you to create sequence diagrams in your VSCode editor. With this extension, you can write ZenUML code and instantly see a rendered sequence diagram that visualizes your code.
|
3 | 4 |
|
| 5 | + |
| 6 | + |
4 | 7 | ## Features
|
| 8 | + |
5 | 9 | - Render ZenUML code to a sequence diagram
|
6 | 10 | - Hot loading for instant visualization updates as you write code
|
7 | 11 |
|
8 | 12 | ## Installation
|
| 13 | + |
9 | 14 | To install the ZenUML VSCode Extension, follow these steps:
|
| 15 | + |
10 | 16 | 1. Open VSCode.
|
11 | 17 | 2. Open the Extension Marketplace by clicking on the Extensions icon in the left-hand side menu.
|
12 | 18 | 3. Search for "ZenUML" and click "Install."
|
13 | 19 | 4. Once the installation is complete, the ZenUML extension will be available in your VSCode editor.
|
14 | 20 |
|
15 | 21 | ## Usage
|
| 22 | + |
16 | 23 | To use the ZenUML VSCode Extension, follow these steps:
|
17 |
| -1. Open a new or existing file in your VSCode editor. |
18 |
| -Write ZenUML code in the file. |
19 |
| -2. Press CTRL+SHIFT+P or CMD+SHIFT+P to open the command palette. |
20 |
| -3. Search for "ZenUML: Preview" and select it. |
| 24 | + |
| 25 | +1. Open a new or existing file with a `.zen` or `.zenuml` file extension. Write ZenUML code in the file. |
| 26 | +2. Press <kbd>CTRL</kbd>+<kbd>SHIFT</kbd>+<kbd>P</kbd> or <kbd>CMD</kbd>+<kbd>SHIFT</kbd>+<kbd>P</kbd> to open the command palette.3. Search for `ZenUML: Preview` and select it. |
21 | 27 | 4. A preview window will open, displaying the rendered sequence diagram based on your ZenUML code.
|
22 | 28 |
|
23 | 29 | ## Contributing
|
| 30 | + |
24 | 31 | If you encounter any issues or bugs with the ZenUML VSCode Extension, please report them on the GitHub repository. Pull requests are also welcome.
|
25 | 32 |
|
26 | 33 | ## License
|
27 |
| -The ZenUML VSCode Extension is licensed under the MIT License. See the LICENSE file for more information. |
| 34 | + |
| 35 | +The ZenUML VSCode Extension is licensed under the MIT License. See the LICENSE file for more information. |
0 commit comments