Gatsby-theme-official-docs NPM

gatsby-theme-official-docs

THIS IS A WORK-IN-PROGRESS

Gatsby theme for gatsbyjs.com/docs using MDX v2 and gatsby-plugin-mdx v4

See the original proposal here:

https://www.notion.so/gatsbyjs/Docs-Theme-eb41c90706cd44b6a0be3dfa19dfa05d

This is a proof-of-concept for splitting the /docs section of gatsbyjs.com out into an open source, installable Gatsby theme. This uses the new gatsby-plugin-mdx v4 and MDX v2 to render docs from gatsbyjs/gatsby using gatsby-source-git.

Once this is ready for production, this theme should be moved to the gatsbyjs/gatsby monorepo and potentially source the MDX docs using gatsby-source-filesystem.

Differences from current implementation

Uses MDX v2 for content and navigation links
- No YAML files are used for the navigation or section pages, which are now in src/pages
Uses custom-built plugins in the plugins directory to replicate the functionality of the current docs
Uses Vanilla Extract for styling
- Does NOT use Emotion
- Does NOT use gatsby-interface
- References to gatsby-interface components in source docs should be removed
Currently uses a precompiled Typography.js CSS file to keep some global styles consistent with gatsbyjs.com
- This should be considered for removal in the future
Only builds pages for docs that are in the following directories: docs/conceptual, docs/how-to, docs/reference, and docs/tutorial
- Legacy orphaned docs should be audited and moved into one of these directories as deemed necessary
- All outdated docs can be either removed or moved into an archive directory
Removes file nodes for docs with invalid syntax, notably the usage of HTML comments () as this is invalid syntax in MDX v2
- These docs should be updated to valid MDX v2 syntax