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

Addon-docs: styleguide support #6645

Open
3 of 4 tasks
shilman opened this issue Apr 26, 2019 · 5 comments
Open
3 of 4 tasks

Addon-docs: styleguide support #6645

shilman opened this issue Apr 26, 2019 · 5 comments

Comments

@shilman
Copy link
Member

shilman commented Apr 26, 2019

Add doc blocks for:

  • Type
  • Colors
  • Icons
  • Documentation

Relies on #6644

@steel
Copy link
Contributor

steel commented Jul 21, 2019

Any update on this? Thanks!

@storybookjs storybookjs deleted a comment from stale bot Jul 21, 2019
@shilman
Copy link
Member Author

shilman commented Jul 21, 2019

This issue has two parts:

  1. Make it easy for users to write MDX files that show up in Storybook but that don't contain any stories Addon-docs: documentation-only support #6644. This is work in progress, but has a workaround that's described in the issue.

  2. Create doc blocks that help document styleguide-type components, such as colors and typography. These are finished (first versions at least) and available in @storybook/addon-docs/blocks and can be embedded in any MDX page.

Therefore, you should be able to add a styleguide to the beginning of your Storybook today using the workaround. But there is still work to do before shipping.

@shilman shilman modified the milestones: 5.2.0, 5.2.x Sep 23, 2019
@shilman
Copy link
Member Author

shilman commented Nov 7, 2019

First version of this is working & demonstrated at https://storybook-design-system.netlify.com/?path=/docs/design-system-colors--page

Needs documentation

@shilman shilman closed this as completed Nov 7, 2019
@shilman shilman reopened this Nov 7, 2019
@shilman shilman modified the milestones: 5.2.x, 5.3.x Jan 11, 2020
@shilman shilman removed this from the 5.3.x milestone Jul 30, 2020
@mayashavin
Copy link

@shilman I couldn't find any docs so have to comment here. Sorry if it is not relevant :)

  1. How do I get the folder of doc stories like in the demo (table of contents section)?
  2. Typography - do I need a special component from the add-on/blocks like ColorPalette and ColorItem?
  3. Where can I find the docs about all the block components? It took me a while to search for ColorPalette and so on. If you need help in documenting it, lmk. I can help also. It is pretty hard to know what to use since there is no reference (unless I misread something :) )
    Thank you.

@valentinpalkovic
Copy link
Contributor

@shilman Is this issue still relevant? Can we close it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Hotlist
Awaiting triage
Development

No branches or pull requests

5 participants