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

Make writing pattern-library documentation/markup easier #1067

Open
lyzadanger opened this issue Jun 1, 2023 · 2 comments
Open

Make writing pattern-library documentation/markup easier #1067

lyzadanger opened this issue Jun 1, 2023 · 2 comments
Labels
code health needs a think pattern library concerning the build, structure, styling or components for the pattern library

Comments

@lyzadanger
Copy link
Contributor

Composing pattern-library documentation isn't sheer hell or anything, but I miss markdown and it can be fiddly. I get annoyed when I have to write markup like this:

<p><code>SomeComponent</code> {"doesn't"} <strong>really</strong> have a type of {`'round' | 'solid'`}</p>

cf. in markdown:

`SomeComponent` doesn't *really* have a type of `'round' | 'solid'`

Perhaps look at where MDX is at or brainstorm other ways to make writing the actual documentation a little nicer.

@lyzadanger lyzadanger added pattern library concerning the build, structure, styling or components for the pattern library needs a think labels Jun 1, 2023
@acelaya
Copy link
Contributor

acelaya commented Jun 2, 2023

+1 to MDX and using markdown in general to write docs.

@robertknight
Copy link
Member

MDX seems like one reasonable option to explore. Another would be some kind of <Markdown/> component within our existing JSX component pages that renders its text children as markdown. A solution that does the markdown -> JSX conversion at build time would be preferable from a performance perspective.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health needs a think pattern library concerning the build, structure, styling or components for the pattern library
Projects
None yet
Development

No branches or pull requests

3 participants