ComplyTime Website

The official website for ComplyTime - Cloud Native Compliance, Reimagined.

Built with Hugo and the Doks theme.

🚀 Quick Start

Prerequisites

• Node.js v22 or later
• npm (included with Node.js)
• Go 1.25+ (for the content sync tool)
• (Recommended) GITHUB_TOKEN env var for higher API rate limits

Development

# Install dependencies
npm install

# Sync project content from GitHub org (generates project pages and cards)
go run ./cmd/sync-content --org complytime --config sync-config.yaml --write

# Start development server
npm run dev

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

Build

# Build for production
npm run build

The output will be in the public/ directory.

📁 Project Structure

website/
├── assets/                # SCSS, JavaScript, images
│   ├── js/
│   │   └── custom.js
│   └── scss/
│       └── common/
│           ├── _custom.scss
│           └── _variables-custom.scss
├── cmd/sync-content/      # Go content sync tool (10 source files, package main)
├── config/                # Hugo configuration
│   ├── _default/
│   │   ├── hugo.toml
│   │   ├── languages.toml
│   │   ├── params.toml
│   │   └── menus/
│   │       └── menus.en.toml
│   ├── production/        # Production overrides
│   └── next/              # Alternative env overrides
├── content/               # Markdown content
│   ├── _index.md          # Homepage
│   ├── docs/              # Documentation
│   │   ├── getting-started/
│   │   └── projects/      # Project pages (generated by sync tool, gitignored)
│   └── privacy.md
├── layouts/               # Custom layouts
│   ├── home.html          # Homepage layout (reads data/projects.json)
│   └── docs/
│       └── list.html      # Docs section listing layout
├── static/                # Static assets (favicons, icons)
├── sync-config.yaml       # Declarative sync configuration
├── .content-lock.json     # Approved upstream SHAs per repo (committed)
├── go.mod / go.sum        # Go module and checksums
├── .github/
│   └── workflows/
│       ├── deploy-gh-pages.yml      # Deploy (sync at locked SHAs + Hugo build)
│       ├── ci.yml                   # PR validation (lint, test, dry-run, build)
│       └── sync-content-check.yml   # Weekly content check (opens PR)
└── package.json

📝 Content

Navigation

Menu Item	URL	Description
Getting Started	/docs/getting-started/	Documentation landing page
Projects	/docs/projects/	ComplyTime project pages
Privacy Policy	/privacy/	Privacy policy

Adding Documentation

Create a new Markdown file in the appropriate directory under content/docs/:

---
title: "Page Title"
description: "Page description"
lead: "Brief intro text"
date: 2024-01-01T00:00:00+00:00
draft: false
weight: 100
toc: true
---

Your content here...

🎨 Customization

Styling

Custom styles are in assets/scss/common/:

• _variables-custom.scss - Variables and theme colors
• _custom.scss - Additional custom styles

Configuration

Site configuration is in config/_default/:

• hugo.toml - Hugo settings
• languages.toml - Language and footer settings
• params.toml - Theme parameters
• menus/menus.en.toml - Navigation menus

🚢 Deployment

The site uses three GitHub Actions workflows:

• ci.yml — validates PRs with go test -race, content sync (with --lock --write), and Hugo build
• sync-content-check.yml — runs weekly to detect upstream doc changes and opens a PR to update .content-lock.json
• deploy-gh-pages.yml — on push to main, syncs content at approved SHAs, builds with Hugo, and deploys public/ to GitHub Pages

Upstream content changes require a reviewed PR before reaching production.

🤝 Contributing

Contributions are welcome! Please see our Contributing Guide.

📄 License

This website is licensed under Apache 2.0.

🔗 Links

• ComplyTime GitHub
• Doks Theme
• Hugo