Skip to content

Commit 8d456c1

Browse files
committed
Add links to online playground
1 parent 08d336a commit 8d456c1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
`web-component-analyzer` is a CLI that makes it possible to easily analyze web components. It analyzes your code and jsdoc in order to extract `properties`, `attributes`, `methods`, `events`, `slots`, `css shadow parts` and `css custom properties`. Works with both javascript and typescript.
1515

16+
Try the online playground [here](https://runem.github.io/web-component-analyzer/)
17+
1618
In addition to [vanilla web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) this tool supports web components built with the following libraries:
1719

1820
- [lit-element](https://github.com/Polymer/lit-element)
@@ -63,6 +65,8 @@ $ wca analyze my-element.js --outFile custom-elements.json
6365
wca analyze src --format json --outFile custom-elements.json
6466
```
6567

68+
Try the online playground [here](https://runem.github.io/web-component-analyzer?format=json)
69+
6670
This json format is for experimental and demo purposes, and is still being actively discussed. You can expect changes to this format. Please follow and contribute to the discussion at:
6771

6872
- https://github.com/webcomponents/custom-elements-json
@@ -74,6 +78,8 @@ This json format is for experimental and demo purposes, and is still being activ
7478
wca analyze src --format markdown --outDir readme
7579
```
7680

81+
Try the online playground [here](https://runem.github.io/web-component-analyzer?format=markdown)
82+
7783
Web Component Analyzer can output markdown documentation of your web components. This can either be output into a single file using `--outFile` or into multiple files using `--outDir`.
7884

7985
### vscode

0 commit comments

Comments
 (0)