Skip to content

Commit 5884e5a

Browse files
Updated readme
1 parent 3d5c034 commit 5884e5a

File tree

5 files changed

+33
-38
lines changed

5 files changed

+33
-38
lines changed

README.md

Lines changed: 33 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,22 @@ OR
3232
## Features
3333
All features can be enabled/disabled in the settings.
3434

35-
- Create groups independently of the nodes ([Updated card menu](#updated-canvas-card-menu))
35+
- Create groups independently of the nodes (Updated card menu)
3636
- More [canvas commands](#canvas-commands)
37-
- (Flowchart) [Node shapes](#node-shapes)
38-
- Terminal shape
39-
- Process shape
40-
- Decision shape
41-
- Input/Output shape
42-
- On-page Reference shape
43-
- Predefined Process shape
44-
- Document shape
45-
- Database shape
37+
- [Node Styles](#node-styles)
38+
- (Flowchart) [Node Shapes](#node-shapes)
39+
- Terminal shape
40+
- Process shape
41+
- Decision shape
42+
- Input/Output shape
43+
- On-page Reference shape
44+
- Predefined Process shape
45+
- Document shape
46+
- Database shape
47+
- [Border Styles](#border-styles)
48+
- Dotted
49+
- Dashed
50+
- Invisible
4651
- [Edge Styles](#edge-styles)
4752
- Edge styles
4853
- Dotted
@@ -79,25 +84,6 @@ If you want to support me and my work, consider starring ⭐ the repository, or,
7984

8085
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/X8X27IA08)
8186

82-
## Updated UI
83-
### Canvas Card Menu
84-
<details>
85-
<summary>Canvas Card Menu</summary>
86-
<img src="./assets/card-menu.png" alt="New canvas card menu"/>
87-
</details>
88-
89-
### Node Popup Menu
90-
<details>
91-
<summary>Node Popup Menu</summary>
92-
<img src="./assets/popup-menu.png" alt="New node popup menu"/>
93-
</details>
94-
95-
### Canvas Control Menu
96-
<details>
97-
<summary>Canvas Control Menu</summary>
98-
<img src="./assets/control-menu.png" alt="New canvas control menu"/>
99-
</details>
100-
10187
## Canvas Commands
10288
- `Advanced Canvas: Create text node`
10389
- Create a new text node
@@ -113,16 +99,17 @@ If you want to support me and my work, consider starring ⭐ the repository, or,
11399
- `Advanced Canvas: Expand node up/down/left/right`
114100
- Expand the selected node in the direction of the arrow keys
115101

116-
## Node Shapes
102+
## Node Styles
103+
### Node Shapes
117104
<details>
118105
<summary>Flowchart Example</summary>
119106
<img src="./assets/sample-flowchart.png" alt="Flowchart Example"/>
120107
</details>
121108

122-
### Usage
123-
- Use the [updated popup menu](#node-popup-menu) set a node's shape
109+
#### Usage
110+
- Use the updated popup menu set a node's shape
124111

125-
### Shapes
112+
#### Shapes
126113
<details>
127114
<summary>Terminal Shape</summary>
128115
<img src="./assets/flowchart-nodes/terminal.png" alt="Terminal Shape"/>
@@ -163,6 +150,14 @@ If you want to support me and my work, consider starring ⭐ the repository, or,
163150
<img src="./assets/flowchart-nodes/database.png" alt="Database Shape"/>
164151
</details>
165152

153+
### Border Styles
154+
Set the style of the border to dotted, dashed or invisible.
155+
156+
<details>
157+
<summary>Border Styles Example</summary>
158+
<img src="./assets/border-styles.png" alt="Border Styles Example"/>
159+
</details>
160+
166161
## Edge Styles
167162
### Edge Styles
168163
Set the style of the edges (arrows) to dotted, short-dashed or long-dashed.
@@ -196,7 +191,7 @@ Add custom colors to the color picker. You can add them using the following css
196191
</details>
197192

198193
## Properties Support
199-
Support for properties in canvas files just like in md files. You can edit the properties using the [updated control menu](#canvas-control-menu).
194+
Support for properties in canvas files just like in md files. You can edit the properties using the updated control menu.
200195

201196
Supported properties:
202197
- `cssclasses`
@@ -241,12 +236,12 @@ In presentation mode, you can navigate through the nodes using the arrow keys. T
241236

242237
### Usage
243238
- Create the first slide
244-
- Create the first slide of the presentation using the [updated popup menu](#node-popup-menu)
245-
- OR create a node and mark it as the first slide using the [updated card menu](#canvas-card-menu)
239+
- Create the first slide of the presentation using the updated popup menu
240+
- OR create a node and mark it as the first slide using the updated card menu
246241
- Add more slides
247242
- Link the slides using arrows
248243
- If you want to loop back to a previous slide, you can number the arrows in the order you want to navigate through them
249-
- <b>TIP:</b> Create slides with consistent dimensions by using the [updated card menu](#canvas-card-menu)
244+
- <b>TIP:</b> Create slides with consistent dimensions by using the updated card menu
250245
- Control the presentation
251246
- Start the presentation using the command palette (`Advanced Canvas: Start presentation`)
252247
- Change slides using the arrow keys
@@ -275,7 +270,7 @@ Collapse and expand groups to organize your canvas.
275270
- BUT to retain some interactivity, it allows zooming to a bounding box (e.g. zoom to selection, zoom to fit all)
276271

277272
### Usage
278-
- Use the [updated control menu](#canvas-control-menu) to toggle the new features (Only shown if the canvas is in readonly mode)
273+
- Use the updated control menu to toggle the new features (Only shown if the canvas is in readonly mode)
279274

280275
## Encapsulate Selection
281276
Move the current selection to a new canvas and create a link in the current canvas.

assets/border-styles.png

9.74 KB
Loading

assets/card-menu.png

-4.1 KB
Binary file not shown.

assets/control-menu.png

-6.95 KB
Binary file not shown.

assets/popup-menu.png

-18.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)