$ cat article/getting-started.md

Getting Started with Hype

# @ Gopher Guides ~ 2 min
#tutorial #getting-started #hype

Getting Started with Hype

Hype is a content engine that makes Markdown dynamic. You can execute code, include files, and validate everything at build time. This guide walks you through installation and your first hype document.

Installation

Install hype with Homebrew:

brew install gopherguides/tap/hype

Or install directly with Go:

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

Verify the installation:

hype version

Your First Hype Document

Create a new file called module.md:

# Hello Hype

This document is powered by hype.

Build it to HTML:

hype export -format html -f module.md

Or export to Markdown (useful for generating README files):

hype export -format markdown -f module.md

Code Execution

One of hype's most powerful features is executing code blocks at build time. When you include a Go source file and mark it for execution, hype runs the code and captures the output.

Create a src/main.go file next to your module.md:

package main

import "fmt"

func main() {
	fmt.Println("Hello from Hype!")
}

Then reference it in your Markdown using hype's include syntax. The code will be executed during build, and the output will appear in your final document.

This means your documentation always reflects the actual behavior of your code. If the code changes, the docs update automatically. If the code breaks, the build fails — so you catch issues before they ship.

Starting a Blog

Hype includes a built-in static blog generator:

hype blog init mysite
cd mysite
hype blog new hello-world
hype blog build
hype blog serve

This creates a full blog with themes, RSS feeds, sitemaps, and SEO support — all powered by hype's dynamic Markdown.

Next Steps