Documentation
Build your documentation site using Contentlayer and MDX.
Check here if your component is not rendering
Astronomy includes a documentation site built using Markdown and MDX.
Features
It comes with the following features out of the box:
- Write content using MDX.
- Transform and validate content using Contentlayer.
- MDX components such as
<Callout />
and<Card />
. - Support for table of contents.
- Custom navigation with prev and next pager.
- Beautiful code blocks using
rehype-pretty-code
. - Syntax highlighting using
shiki
. - Built-in search (in progress).
- Dark mode (in progress).
How is it built
Click on a section below to learn how the documentation site built.
Contentlayer
Learn how to use MDX with Contentlayer.
Components
Using React components in Mardown.
Code Blocks
Beautiful code blocks with syntax highlighting.
Style Guide
View a sample page with all the styles.