Installation

This guide covers installing and configuring Hermes for your project.

Prerequisites

Before you begin, make sure you have:

• Node.js 18+ installed
• npm, yarn, or pnpm package manager
• A code editor (VS Code recommended)

Installation Methods

Using npm

npm install

Using yarn

yarn install

Using pnpm

pnpm install

Configuration

After installation, you’ll need to configure a few things:

1. Update site configuration

Edit src/config.ts to customize your site:

export const siteConfig = {
  name: 'Your Project Name',
  title: 'Your Documentation',
  // ... other settings
};

2. Add your content

Create documentation files in src/content/docs/:

---
title: My Page
description: Page description
---

# My Page

Your content here...

3. Customize styling

Modify tailwind.config.mjs to match your brand colors.

Development

Start the development server:

npm run dev

The site will be available at http://localhost:4321.

Building for Production

Build your site for production:

npm run build

Preview the production build:

npm run preview

Deployment

Hermes is ready to deploy to:

• Vercel: Connect your repository and deploy
• Netlify: Use the included netlify.toml
• Cloudflare Pages: Use the included configuration

See the Deployment Guide for more details.