$ cat article/docs/blog.md

Blog Generator

# @ Gopher Guides ~ 2 min
#docs #blog #hype

Blog Generator

Create beautiful static blogs with hype's signature code execution feature. Write articles in markdown, include runnable code examples, and deploy to GitHub Pages with a single workflow.

Live Demo: gopherguides.github.io/hype-blog-sample

Quick Start

# Install hype
go install github.com/gopherguides/hype/cmd/hype@latest

# Create a new blog
hype blog init mysite
cd mysite

# Create your first article
hype blog new hello-world

# Build and preview
hype blog build
hype blog serve

Your site is now live at http://localhost:3000.

Features

  • Code Execution - Run code blocks and include real output (hype's signature feature)
  • 3 Built-in Themes - suspended (minimal), developer (terminal-style), cards (grid layout)
  • Hugo-style Templates - Layered template system with easy customization
  • Live Reload - --watch flag for automatic rebuilds during development
  • SEO Ready - Meta tags, Open Graph, Twitter cards, sitemap, RSS feed
  • GitHub Pages - Deploy automatically with the included workflow

Commands

Command Description
hype blog init <name> Create a new blog project
hype blog new <slug> Create a new article
hype blog build Build the static site
hype blog serve Start local preview server
hype blog serve –watch Preview with live reload
hype blog theme list List available themes
hype blog theme add <name> Add a theme to your project

Themes

Suspended (Default)

Minimal, typography-focused theme perfect for technical writing.

Suspended Theme

Developer

Dark, terminal-inspired theme for code-heavy blogs.

Developer Theme

Cards

Modern card-based layout with visual hierarchy.

Cards Theme

Switch themes by updating config.yaml:

theme: "developer"

Deploy to GitHub Pages

Add this workflow to .github/workflows/deploy.yaml:

Then enable GitHub Pages in your repo settings (Settings > Pages > Source: GitHub Actions).

Project Structure

Article Format

Articles use a <details> block for metadata:

# My Article Title



Your content here...

Full Documentation

For complete documentation including theme customization, template overrides, and advanced features, see docs/blog/README.md.