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

206-research-the-possibility-to-include-assets-in-mdx-documentation-files #217

Conversation

verena-ifx
Copy link
Contributor

@verena-ifx verena-ifx commented Jul 3, 2023

…include custom mdx files

By creating this pull request you agree to the terms in CONTRIBUTING.md.
https://github.com/Infineon/.github/blob/master/CONTRIBUTING.md
--- DO NOT DELETE ANYTHING ABOVE THIS LINE ---

Description
This includes the latest storybook configuration that allows adding custom .mdx files (Usage.mdx) to each component folder.
The former "Docs" Page, (now renamed to Development), now needs to added manually to each story via:

export default {
  title: "Components/Checkbox",
  tags: ['autodocs'], <--
  args: {
   ....
  },
...
}

Like this, the autodocs page will be created with the new name 'Development'. Instead of the autogenerated page, it is possible to simply create a 'Development.mdx' file and reference the story, the controls, props etc. AND additionally add custom markdown, assets, etc. for further documentation

📦 Published PR as canary version: 18.2.11--canary.217.a188dd936d2be52ad06c1765d59665a2c30e9f5b.0

✨ Test out this PR locally via:

npm install @infineon/infineon-design-system-stencil@18.2.11--canary.217.a188dd936d2be52ad06c1765d59665a2c30e9f5b.0
# or 
yarn add @infineon/infineon-design-system-stencil@18.2.11--canary.217.a188dd936d2be52ad06c1765d59665a2c30e9f5b.0

@verena-ifx verena-ifx linked an issue Jul 3, 2023 that may be closed by this pull request
@verena-ifx verena-ifx changed the title includes unfinished ratio-btn and updated storybook configuration to … 206-research-the-possibility-to-include-assets-in-mdx-documentation-files Jul 3, 2023
@verena-ifx verena-ifx merged commit 2645372 into master Jul 4, 2023
9 checks passed
@verena-ifx verena-ifx deleted the 206-research-the-possibility-to-include-assets-in-mdx-documentation-files branch July 4, 2023 11:45
@github-actions
Copy link
Contributor

github-actions bot commented Jul 4, 2023

🚀 PR was released in v18.2.11 🚀

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

Successfully merging this pull request may close these issues.

Research the possibility to include assets in mdx documentation files
1 participant