v2

Configuration

Customize HermesDocs for your project

1 min read

Configuration

All configuration for HermesDocs is centered in src/config.ts. This file controls site metadata, navigation, search, and versioning.

Site Configuration

export const siteConfig = {
  name: 'HermesDocs',
  title: 'Hermes Documentation',
  description: 'Professional documentation kit built with Astro',
  url: 'https://your-site.com',
  author: {
    name: 'Your Name',
    email: 'you@example.com',
    url: 'https://your-site.com',
  },
  // ...
};

Versioning

Configure available documentation versions in the versions array:

versions: [
  { label: 'v2.0', value: 'v2', current: true },
  { label: 'v1.0', value: 'v1', current: false },
],
defaultVersion: 'v2',

Search (Algolia)

For Algolia-powered search, set environment variables:

  • PUBLIC_ALGOLIA_APP_ID
  • PUBLIC_ALGOLIA_API_KEY
  • PUBLIC_ALGOLIA_INDEX_NAME

GitHub Integration

Configure your repository for “Edit on GitHub” links:

github: {
  repo: 'username/repo-name',
  editBaseUrl: 'https://github.com/username/repo/edit/main',
},