Valhalla

Take a deep dive into our latest launch, the Valhalla Content Hub!

ContactSign Up for Free

Improving React Component Library Documentation with Gatsby and MDX

Greg Thomas
April 9th, 2020

Welcome to the Gatsby Days 2020 Video Blog: Los Angeles Edition. In this series of eleven videos, you can catch up with all the wit and wisdom shared at the presentations from our February community gathering in LA. If you weren’t able to make it in person, these videos are the next best thing to owning a time machine! (Though owning a time machine would be super cool for sure, joining us at our next Gatsby Days—currently scheduled as a virtual event June 2nd-3rd—would be pretty awesome, too 💜. Follow Gatsby on Twitter to keep up with when registration starts, speaker announcements and other developments).

Kathleen McMahon is a senior front-end software engineer and the tech lead for O’Reilly Media’s Design System team. Recently, her team decided it was time to rework the design system’s component library documentation. The primary goals: encourage more contributions by making the documentation process more user friendly and improve accessibility so more users could take advantage of the resulting documentation.

Her team’s solution was to incorporate Gatsby with MDX into the documentation tooling. Learn how Kathleen’s team implemented these technologies and discover ways to customize your own implementation using several Gatsby plugins. Hear how the Design System team O’Reilly Media has been able to reduce barriers for contributions, minimize documentation maintenance burdens, and make the documentation area more inclusive.

Share on TwitterShare on LinkedInShare on FacebookShare via Email

Writer, musician, historian, and dedicated service provider for the dog.

Tagged with accessibility, component-libraries, gatsby-days, markdown, plug-ins, reactView all Tags

Talk to our team of Gatsby Experts to supercharge your website performance.

Contact Gatsby Now
© 2022 Gatsby, Inc.