-
Notifications
You must be signed in to change notification settings - Fork 2
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
Research porting docs to Docusaurus and remove them from Storybook #274
Comments
I've started some research into this. As far as I can tell, we should be able to copy MDX directly from storybook into Docusaurus and use that. Docusaurus allows you to define and use React components inside an MDX file, which might simplify our setup of demo files (StoryBook may allow this too, I haven't looked into it yet, but I haven't seen it happening in code so far). I found this Docusaurus addon for integrating Docusaurus and Storybook. The documentation is sparse, but from what there is it looks more aimed at using Docusaurus components in Storybook stories. Still, it might be wroth investigating further, or using as a reference if. This comment on a Docusaurus Github issue discusses and has an example of embedding a Storybook story in Docusaurus. It seems to work pretty well, though it's in an iframe and still has Storybook styles (you also can't scroll inside the iframe, but I'm guessing that's a bug in their code). Given Docusaurus's MDX support, I think that route might be the simplest and most straightforward in terms of initial dev and later maintenance. I think we would lose out on Storybook's component configuration preview, but we may be able to include enough interaction with wrapper components around the demo's. It might be worth doing a quick prototype with one or two components to see how it goes. |
Lots of inspiration for design system websites here - https://designsystemsrepo.com/design-systems/ At the most basic level: Homepage / intro Having each component page tab based allows us to scale easily. Deciding on what exactly these tabs, and indeed the level and format of the detail is a fairly big discussion/job in itself, which we should work alongside the DS community on. Formidable designers have been working on https://designsystem.puma.com/ , so we could also learn a lot from them. But first, I would suggest:
|
@nstolpe - this might be useful https://www.youtube.com/watch?v=2R53Y7eP45k |
GitHub's Primer website is a good source of inspiration, if not a good idea for an implementation even
The text was updated successfully, but these errors were encountered: