Getting started
Project structure
How files map to URLs and sidebar entries.
import { defineConfig } from 'astro/config';
import mines from '@deltaq.dev/mines';
export default defineConfig({
integrations: [mines({ title: 'My Docs' })],
});import { defineCollection } from 'astro:content';
import { docsLoader, docsSchema } from '@deltaq.dev/mines/loader';
export const collections = {
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
};---
title: Introduction
------
title: Installation
------
title: Theming
---:root {
--accent: #7c3aed;
}Ordering
Numeric prefixes set the order of folders and pages and are removed from URLs.
| File | URL |
|---|---|
1.getting-started/1.introduction.mdx |
/getting-started/introduction |
2.guides/index.mdx |
/guides |
index.mdx |
/ |
Without a root index.mdx, / redirects to the first page.
Frontmatter
titlestringrequired
Page title, used in the sidebar, header and search results.
descriptionstring
Shown under the title and used for meta tags.
tocbooleandefault: true
Hide the table of contents with
false.related(string | { label: string; href: string })[]default: []
Links shown below the table of contents. A string is a page slug such as guides/theming, and its title is used as the label. Unknown slugs fail the build.