Using Themes for Distributed Docs
Blog post from Gatsby
Gatsby provides an effective solution for building static documentation websites by utilizing Markdown files, making it a suitable choice for companies like Apollo, which deals with documentation spread across multiple repositories. The challenge Apollo faced was unifying these repositories into a cohesive site without the need to rebuild the entire website for every update. By employing Gatsby Themes, they can configure a single Gatsby website that can be applied across multiple sources, allowing each repository to operate independently while maintaining a consistent layout. Gatsby Themes offer flexibility through configurable plugins and GraphQL queries, facilitating version control and navigation via gatsby-source-git, while Gatsby Remark plugins enhance Markdown parsing capabilities, enabling features like internal link checking. Additionally, MDX allows for the integration of React components within Markdown, enabling rich, interactive documentation and shared content across pages. This approach not only streamlines the documentation process but also makes it more enjoyable and efficient, leveraging familiar technology to quickly deploy features. Apollo's journey with Gatsby Themes and the broader ecosystem demonstrates how these tools can deliver a consistent and dynamic documentation experience.
| Trend | Post Mentions | Total Month Mentions | Posts | Companies | MoM |
|---|---|---|---|---|---|
| Developer Experience | 1 | 51 | 16 | 12 | +89% |
Use this post, company, and trend context to find content marketing opportunities, perform competitive analysis, or address product feature gaps via the Plushcap MCP server or the Plushcap API.