Skip to content

Commit

Permalink
docs(docs-custom): add overview field (#928)
Browse files Browse the repository at this point in the history
this commit adds the 'overview' field on the `JsonDocsComponent` model,
introduced in ionic-team/stencil#3766. it also
updates the description of the 'docs' field in the same model to better
reflect its functionality
  • Loading branch information
rwaskiewicz authored Oct 26, 2022
1 parent 7e30479 commit 184646e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/docs/output-targets/docs-custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,9 @@ The generated docs JSON data will in the type of `JsonDocs` which consists of ma
| `encapsulation` | Component `encapsulation` type. Possible values are `shadow`, `scoped`, `none` |
| `tag` | Component tag described in `.tsx` file |
| `readme` | Component readme file first line content |
| `docs` | Description written in top of `@Component` e.g. /** Documentation Example */ |
| `docs` | Description written in top of `@Component` e.g. /** Documentation Example */. If no JSDoc is present, default to any manually written text in the component's markdown file. Empty otherwise. |
| `docsTags` | Annotations (In the way of JSDoc ) written in `.tsx` file will be collected here |
| `overview` | Description written in top of `@Component` e.g. /** Documentation Example */ |
| `usage` | |
| `props` | Array of component properties information |
| `methods` | Array of component methods information |
Expand Down

1 comment on commit 184646e

@vercel
Copy link

@vercel vercel bot commented on 184646e Oct 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.