likec4 0.48.0 → 0.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -6
- package/dist/cli/index.js +173 -166
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
Features:
|
|
6
6
|
|
|
7
|
-
- Preview diagrams in a local web server (with lightning
|
|
7
|
+
- Preview diagrams in a local web server (with lightning-fast updates) ⚡️
|
|
8
8
|
- Build a static .website (deploy to github pages, netlify...) 🔗
|
|
9
|
-
- Export to PNG, Mermaid, Dot, D2 (if you something static) 🖼️
|
|
9
|
+
- Export to PNG, JSON, Mermaid, Dot, D2 (if you need something static) 🖼️
|
|
10
10
|
- Generate React components (for custom integrations ) 🛠️
|
|
11
11
|
|
|
12
12
|
## Install
|
|
@@ -76,7 +76,7 @@ likec4 start
|
|
|
76
76
|
likec4 dev
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
This recursively
|
|
79
|
+
This recursively searches for `*.c4`, `*.likec4` files in the current folder, parses and serves diagrams in a local web server.
|
|
80
80
|
Any changes in the sources trigger a super-fast hot update and you see changes in the browser immediately.
|
|
81
81
|
|
|
82
82
|
> **Tip:**
|
|
@@ -92,7 +92,7 @@ likec4 build -o ./dist
|
|
|
92
92
|
|
|
93
93
|
Example [https://template.likec4.dev](https://template.likec4.dev/view/cloud)
|
|
94
94
|
|
|
95
|
-
When you
|
|
95
|
+
When you deploy the website, you can use the "Share" button to get links.
|
|
96
96
|
|
|
97
97
|
> **Tip:**
|
|
98
98
|
> [likec4/template](https://github.com/likec4/template) repository demonstrates how to deploy to github pages.
|
|
@@ -111,9 +111,15 @@ For example, this command can be used on CI, to compare diagrams with ones from
|
|
|
111
111
|
likec4 export png -o ./assets
|
|
112
112
|
```
|
|
113
113
|
|
|
114
|
-
This command starts local web server and uses Playwright to take screenshots.
|
|
114
|
+
This command starts the local web server and uses Playwright to take screenshots.
|
|
115
115
|
If you plan to use it on CI, refer to [Playwright documentation](https://playwright.dev/docs/ci) for details.
|
|
116
116
|
|
|
117
|
+
### Export to JSON
|
|
118
|
+
|
|
119
|
+
```sh
|
|
120
|
+
likec4 export json -o dump.json
|
|
121
|
+
```
|
|
122
|
+
|
|
117
123
|
### Export to Mermaid, Dot, D2
|
|
118
124
|
|
|
119
125
|
Export to various formats via codegen:
|
|
@@ -165,4 +171,4 @@ yarn dev
|
|
|
165
171
|
|
|
166
172
|
## Support
|
|
167
173
|
|
|
168
|
-
If there's a problem you're encountering or something you need help with, don't hesitate to take advantage of my [_Priority Support_ service](https://github.com/sponsors/davydkov) where you can ask me questions in an exclusive forum. I'm well
|
|
174
|
+
If there's a problem you're encountering or something you need help with, don't hesitate to take advantage of my [_Priority Support_ service](https://github.com/sponsors/davydkov) where you can ask me questions in an exclusive forum. I'm well-equipped to assist you with this project and would be happy to help you out! 🙂
|