Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs-json output #2196

Closed
dmartinjs opened this issue Feb 13, 2020 · 1 comment
Closed

docs-json output #2196

dmartinjs opened this issue Feb 13, 2020 · 1 comment
Labels

Comments

@dmartinjs
Copy link

Stencil version:

I'm submitting a:

[ ] bug report
[x] feature request
[ ] support request => Please do not submit support requests here, use one of these channels: https://stencil-worldwide.herokuapp.com/ or https://forum.ionicframework.com/

Current behavior:

Currently, the json documentation generated by Stencil don't match the effort made by https://github.com/webcomponents/custom-elements-json to have a standard for describing custom-elements (used by Storybook in Docs addon to generate documentation for webcomponents).

Expected behavior:

Expect the output to be formatted like standardised in https://github.com/webcomponents/custom-elements-json

@manucorporat
Copy link
Contributor

There is not any standard about a json describing web components, the docs-json includes way more information than other projects do, however stencil already has a output target for vscode's json:

    {
      type: 'docs-vscode',
      file: 'custom-elements.json'
    },

Add the docs-vscode to outputTargets in your stencil.config.ts!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants