Docs
CMS
Documentation
Learn how to use the documentation in Achromatic.
Add a new documentation page
To create a new page, follow these steps:
-
Create a new file
Navigate to the/apps/marketing/content/docs
directory and create a new.mdx
file.
The file name will act as the URL slug for the post. For example:- File name:
hello-world.mdx
- URL:
https://your-app.com/docs/hello-world
- File name:
-
Add metadata
At the top of the.mdx
file, include a frontmatter block. This block contains key metadata about your docs, written in a YAML-like format enclosed by three dashes (---
). Here's an example:
---
title: Hello World
description: This is my first documentation page.
---
Link the new documentation page
Add the last item to DOCS_LINKS
inside apps/marketing/components/marketing-links
.
{
title: 'Guides',
icon: <BookIcon className="size-4 shrink-0 text-muted-foreground" />,
items: [
{
title: 'Introduction',
href: '/docs',
items: []
},
{
title: 'Dependencies',
href: '/docs/dependencies',
items: []
},
{
title: 'Hello World',
href: '/docs/hello-world',
items: []
}
]
}
Your docs are automatically added to the search.