Configuration

All options are passed to mines() in astro.config.mjs. Only title is required.

astro.config.mjs

mines({
  title: 'Mines',
  logo: '/logo.svg',
  favicon: '/favicon.svg',
  description: 'A minimal docs theme for Astro.',
  github: 'owner/repo',
  editUrl: 'https://github.com/owner/repo/edit/main/',
  subNav: 'header',
  groups: { api: 'API reference' },
  tocLinks: {
    title: 'Community',
    links: [{ label: 'Discord', href: 'https://discord.gg/example' }],
  },
  customCss: ['./src/styles/theme.css'],
  components: { Footer: './src/components/Footer.astro' },
  mdxComponents: { Video: './src/components/Video.astro' },
});

Options

titlestringrequired

Site name, shown in the header, page titles and OG images.

descriptionstring

Fallback meta description and the summary line of llms.txt.

faviconstring

Icon path under public/, such as /favicon.svg.

logostring

Image shown before the title in the header, as a path under public/, such as /logo.svg.

githubstring

Repository as owner/repo. Adds a header link and a “Report an issue” link.

editUrlstring

Base URL that each page’s file path is appended to. Must end with / and point at your project root.

subNav'none' | 'header'default: 'none'

With header, top-level folders become tabs under the header and the sidebar shows only the active section.

groupsRecord<string, string>default: {}

Sidebar labels for folder names that should not be title-cased automatically.

ogbooleandefault: true

Generate an Open Graph image for every page at build time.

tocLinks{ title?: string; links: { label: string; href: string }[] }

Links shown below the table of contents on every page. title defaults to “Links”.

customCssstring[]default: []

Stylesheets loaded after the theme. See Theming.

componentsPartial<Record<Slot, string>>default: {}

Replace layout slots with your own components. See Overriding components.

mdxComponentsRecord<string, string>default: {}

Extra components available in every MDX file without imports.