Skip to content

Commit ffbe700

Browse files
committed
docs: pr comments
1 parent 8bbb066 commit ffbe700

File tree

3 files changed

+48
-2
lines changed

3 files changed

+48
-2
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{%- for entry in collections.header %}
2+
<a href="{{ entry.url | url }}" class="
3+
{% if entry.url == page.url %} current {% endif %}
4+
{% if page.url and page.url.search and (page.url.search(entry.url) !== -1) and (page.url !== '/') %} active {% endif %}
5+
">{{ entry.data.eleventyNavigation.key }}</a>
6+
{%- endfor %}
7+
<a href="https://custom-elements-manifest.netlify.app/" target="_blank" rel="noreferrer noopeneer">Playground</a>

docs/analyzer/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ You can also run the analyzer in the browser. You can import it like so:
383383
384384
const manifest = create({
385385
modules,
386-
plugins: [litPlugin()],
386+
plugins: [...litPlugin()],
387387
dev: false
388388
});
389389

packages/analyzer/README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,42 @@
11
# @custom-elements-manifest/analyzer
22

3-
[=> See Source <=](../../docs/analyzer/index.md)
3+
<!-- [=> See Source <=](../../docs/analyzer/index.md) -->
4+
5+
Custom Elements Manifest is a file format that describes custom elements. This format will allow tooling and IDEs to give rich information about the custom elements in a given project. You can find the repository for the specification of the schema [here](https://github.com/webcomponents/custom-elements-manifest).
6+
7+
> ✨ Try it out in the [online playground](https://custom-elements-manifest.netlify.app/)! ✨
8+
9+
[**Read the Docs**](https://custom-elements-manifest.open-wc.org/)
10+
11+
## Install
12+
13+
```bash
14+
npm i -D @custom-elements-manifest/analyzer
15+
```
16+
17+
## Usage
18+
19+
```bash
20+
custom-elements-manifest analyze
21+
```
22+
23+
or
24+
25+
```bash
26+
cem analyze
27+
```
28+
29+
## Options
30+
31+
| Command/option | Type | Description | Example |
32+
| ---------------- | ---------- | ----------------------------------------------------------- | --------------------- |
33+
| analyze | | Analyze your components | |
34+
| --globs | string[] | Globs to analyze | `--globs "foo.js"` |
35+
| --exclude | string[] | Globs to exclude | `--exclude "foo.js"` |
36+
| --outdir | string | Directory to output the Manifest to | `--outdir dist` |
37+
| --watch | boolean | Enables watch mode, generates a new manifest on file change | `--watch` |
38+
| --dev | boolean | Enables extra logging for debugging | `--dev` |
39+
| --litelement | boolean | Enable special handling for LitElement syntax | `--litelement` |
40+
| --fast | boolean | Enable special handling for FASTElement syntax | `--fast` |
41+
| --stencil | boolean | Enable special handling for Stencil syntax | `--stencil` |
42+
| --catalyst | boolean | Enable special handling for Catalyst syntax | `--catalyst` |

0 commit comments

Comments
 (0)