docs(docs-custom): add overview field #928
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
14 tasks
rwaskiewicz
commented
Oct 25, 2022
| @@ -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. | | |||
There was a problem hiding this comment.
I didn't try too hard on formatting here, since I'm rewriting the documentation generation docs
tanner-reits
approved these changes
Oct 25, 2022
alicewriteswrongs
approved these changes
Oct 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
this commit adds the 'overview' field on the
JsonDocsComponentmodel, introduced in ionic-team/stencil#3766. it also updates the description of the 'docs' field in the same model to better reflect its functionality