Open lyzadanger opened 1 year ago
+1 to MDX and using markdown in general to write docs.
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.
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:
cf. in markdown:
Perhaps look at where MDX is at or brainstorm other ways to make writing the actual documentation a little nicer.