Skip to content

Commit 5602833

Browse files
authored
Feature/bump-zenuml-core-version (#6)
* chore(package.json): update @zenuml/core to version 3.24.5 * feat: ⬆️ upgrade zenumo-core dependency * feat: 💄 add new themes and render mode options to configuration * docs: 📝 add demo gif to README.md. Improve usage description * chore: update Node.js version to 18 in release, main workflow and package.json * docs: update file extensions in README.md and improve usage description * chore: update Node.js and @types dependencies in package.json
1 parent a0dd2c3 commit 5602833

File tree

10 files changed

+877
-469
lines changed

10 files changed

+877
-469
lines changed

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
- name: Install Node.js
1414
uses: actions/setup-node@v3
1515
with:
16-
node-version: 16
16+
node-version: 18
1717
- name: Install dependencies
1818
run: npm install --save-exact
1919
- name: Linting

.github/workflows/release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
- name: Install Node.js
1616
uses: actions/setup-node@v3
1717
with:
18-
node-version: 16
18+
node-version: 18
1919
- name: Install dependencies
2020
run: npm install --save-exact
2121
- name: Publish to Visual Studio Marketplace

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,35 @@
1-
# ![img](assets/zenuml-icon.png) ZenUML VSCode Extension
1+
# ![img](assets/zenuml-icon.png) ZenUML VSCode Extension
2+
23
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.
34

5+
![Demo](assets/demo.gif)
6+
47
## Features
8+
59
- Render ZenUML code to a sequence diagram
610
- Hot loading for instant visualization updates as you write code
711

812
## Installation
13+
914
To install the ZenUML VSCode Extension, follow these steps:
15+
1016
1. Open VSCode.
1117
2. Open the Extension Marketplace by clicking on the Extensions icon in the left-hand side menu.
1218
3. Search for "ZenUML" and click "Install."
1319
4. Once the installation is complete, the ZenUML extension will be available in your VSCode editor.
1420

1521
## Usage
22+
1623
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.
2127
4. A preview window will open, displaying the rendered sequence diagram based on your ZenUML code.
2228

2329
## Contributing
30+
2431
If you encounter any issues or bugs with the ZenUML VSCode Extension, please report them on the GitHub repository. Pull requests are also welcome.
2532

2633
## 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.

assets/demo.gif

474 KB
Loading

0 commit comments

Comments
 (0)