Chronicle
IntroductionQuick startProject structure

Pages and frontmatterNavigationComponentsImagesLinks and redirectsAuthors and bylines

Versioned documentationAPI referenceSearchMultiple content sectionsMove an existing docs site

Choosing a themeTheme options

chronicle.yamlFrontmatter fieldsCLI commandsGenerated routes

Build and serveDeployDockerMonitoring

Docker

Chronicle is available as a Docker image on Docker Hub.

Pull the Image

docker pull raystack/chronicle

Production Server

The default command builds and starts a production server on port 3000.

docker run -p 3000:3000 -v ./content:/content raystack/chronicle

Mount your content directory (containing MDX files) to /content. Place chronicle.yaml in the content directory or it will use defaults.

Development Server

Override the default command with dev for hot reload:

docker run -p 3000:3000 -v ./content:/content raystack/chronicle dev --port 3000

Custom Port

docker run -p 8080:8080 -v ./content:/content raystack/chronicle serve --port 8080

Docker Compose

services:
  docs:
    image: raystack/chronicle
    ports:
      - "3000:3000"
    volumes:
      - ./content:/content

Available Commands

The entrypoint is chronicle, so any CLI command can be passed:

# Build only
docker run -v ./content:/content raystack/chronicle build

# Start pre-built server
docker run -p 3000:3000 -v ./content:/content raystack/chronicle start --port 3000

# Build and start (default)
docker run -p 3000:3000 -v ./content:/content raystack/chronicle serve --port 3000
DeployMonitoring