marigold-ui / marigold

Design System based on react-aria and Tailwind CSS
https://marigold-ui.io
MIT License
101 stars 7 forks source link

Create infrastructure and template for component pages #925

Closed ti10le closed 2 years ago

ti10le commented 3 years ago

We need a structure to create all component markdown pages. Before we add all mdx files from storybook to gatsby we have to add one functional and good looking example.

Structure:

Todos for mdx in gatsby:

viktoria-schwarz commented 3 years ago

In the headline you mention to create a template, is that intentional? Or should we rather just start with one component and the outline you gave and then adjust this to each individual component. I don't think working with a real template saves us time....

Also I don't fully understand your point

enable own table styling in gatsby markdown

Can you explain what you mean by that?

ti10le commented 3 years ago

Or should we rather just start with one component and the outline you gave and then adjust this to each individual component.

This is what I mean

Can you explain what you mean by that?

It means that actually you got a non-bordered table with no padding, etc. if you create a table in gatsby. You need to add a plugin or s.e. to show a nice table view

ti10le commented 3 years ago

Template could be a few things. It's not 100% clear. What I mean: Create something like a frame/base structure to show how to add our existing stories pages to Gatsby. Not sure if its just adding a few plugins and copy/paste some parts or a Gatsby template for the whole page. This is what we have to find out 🤷🏽‍♂️ Difficult to explain in a good way.. maybe talk about it on monday

viktoria-schwarz commented 3 years ago

We conclude we want all component pages in our documentation with the same structure (the one given in this issue). We need to look for suitable plugins to implement the table, code blocks and code highlighting.

ti10le commented 3 years ago

actually we have:

sebald commented 2 years ago

What we should do in this cycle for this umbrella issue:

ti10le commented 2 years ago

actually we have:

ti10le commented 2 years ago

Two open points in #1111 and #1112