Hype is a content generation tool that use traditional Markdown syntax, and allows it to be extended for almost any use to create dynamic, rich, automated output that is easily maintainable and reusable.
Hype follows the same principals that we use for coding:
- packages (keep relevant content in small, reusable packages, with all links relative to the package)
- reuse - write your documentation once (even in your code), and use everywhere (blog, book, github repo, etc)
- partials/includes - support including documents into a larger document (just like code!)
- validation - like tests, but validate all your code samples are valid (or not if that is what you expect).
- asset validation - ensure local assets like images, etc actually exist
This README was created with hype. Here was the command we used to create it:
From the .hype directory, run:
hype export -format=markdown -f hype.md > ../README.md
You can also use a github action to automatically update your README as well.
For more in depth examples, you can read our quick start guide here.
This is the syntax to include a code sample in your document:
<code src="src/hello/main.go" snippet="example"></code>
The above code snippet does the following:
- Includes the code snippet specified in the source code
- Validates that the code compiles
Here is the source file:
package main
import "fmt"
// snippet: example
func main() {
fmt.Println("Hello World")
}
// snippet: exampleNotice the use of the snippet comment. The format for the comment is:
// snippet: <snippet_name_here>
You must have a beginning and an ending snippet for the code to work.
The output of including that tag will be as follows:
func main() {
fmt.Println("Hello World")
}source: docs/quickstart/src/hello/main.go:example
A snippet is not required in your code tag. The default behavior of a code tag is to include the entire source file.
If we leave the tag out, it will result in the following code being included:
package main
import "fmt"
func main() {
fmt.Println("Hello World")
}source: docs/quickstart/src/hello/main.go
Notice that none of the snippet comments were in the output? This is because hype recognizes them as directives for the document, and will not show them in the actual output.
There are a number of Go specific commands you can run as well. Anything from executing the code and showing the output, to including go doc (from the standard library or your own source code), etc.
Let's look at how we use the go tag.
Here is the source code of the Go file we are going to include. Notice the use of the snippet comments to identify the area of code we want included. We'll see how to specify that in the next section when we include it in our markdown.
The following command will include the go source code, run it, and include the output of the program as well:
<go src="src/hello" run="."></go>
Here is the result that will be included in your document from the above command:
$ go run .
Hello World
--------------------------------------------------------------------------------
Go Version: go1.23.1
If you want to both run and show the code with the same tag, you can add the code attribute to the tag:
<go src="src/hello" run="." code="main.go"></go>
Now the source code is includes, as well as the output of the program:
package main
import "fmt"
func main() {
fmt.Println("Hello World")
}source: docs/quickstart/src/hello/main.go
$ go run .
Hello World
--------------------------------------------------------------------------------
Go Version: go1.23.1
You can also specify the snippet in a go tag as well. The result is that it will only include the code snippet in the included source:
<go src="src/hello" run="." code="main.go#example"></go>
You can see now that only the snippet is included, but the output is still the same:
func main() {
fmt.Println("Hello World")
}source: docs/quickstart/src/hello/main.go#example:example
$ go run .
Hello World
--------------------------------------------------------------------------------
Go Version: go1.23.1
What if you want to include an example of code that does not compile? We still want the code to be parsed and included, even though the code doesn't compile. For this, we can state the expected output of the program.
<go src="src/broken" run="." code="main.go#example" exit="1"></go>
The result now includes the snippet, and the error output from trying to compile the invalid source code.
func main() {
fmt.Prin("Hello World")
}source: docs/quickstart/src/broken/main.go#example:example
$ go run .
# github.com/gopherguides/hype/.
./main.go:7:6: undefined: fmt.Prin
--------------------------------------------------------------------------------
Go Version: go1.23.1
While there are a number of godoc commands that will allow you to put your documentation from your code directly into your articles as well. Here are some of the commands.
Here is the basic usage first:
<go doc="-short context"></go>
Here is the output for the above command:
$ go doc -short context
var Canceled = errors.New("context canceled")
var DeadlineExceeded error = deadlineExceededError{}
func AfterFunc(ctx Context, f func()) (stop func() bool)
func Cause(c Context) error
func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
func WithCancelCause(parent Context) (ctx Context, cancel CancelCauseFunc)
func WithDeadline(parent Context, d time.Time) (Context, CancelFunc)
func WithDeadlineCause(parent Context, d time.Time, cause error) (Context, CancelFunc)
func WithTimeout(parent Context, timeout time.Duration) (Context, CancelFunc)
func WithTimeoutCause(parent Context, timeout time.Duration, cause error) (Context, CancelFunc)
type CancelCauseFunc func(cause error)
type CancelFunc func()
type Context interface{ ... }
func Background() Context
func TODO() Context
func WithValue(parent Context, key, val any) Context
func WithoutCancel(parent Context) Context
--------------------------------------------------------------------------------
Go Version: go1.23.1
You can also be more specific.
<go doc="-short context.WithCancel"></go>
Here is the output for the above command:
$ go doc -short context.WithCancel
func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
WithCancel returns a copy of parent with a new Done channel. The returned
context's Done channel is closed when the returned cancel function is called
or when the parent context's Done channel is closed, whichever happens
first.
Canceling this context releases resources associated with it, so code should
call cancel as soon as the operations running in this Context complete.
--------------------------------------------------------------------------------
Go Version: go1.23.1
For more examples, see the hype repo.
You can also use the cmd tag and the exec attribute to run arbitrary commands and include them in your documentation. Here is the command to run the tree command and include it in our documentation:
<cmd exec="tree" src="."></cmd>Here is the output:
$ tree
.
├── hype.md
├── includes.md
└── src
├── broken
│ └── main.go
└── hello
└── main.go
3 directories, 4 filesThere are several options for running the hype command. Most notable is the export option:
`$ hype export -h
Usage of hype: -f string optional file name to preview, if not provided, defaults to hype.md (default "hype.md") -format string content type to export to: markdown, html (default "markdown") -timeout duration timeout for execution, defaults to 30 seconds (30s) (default 5s) -v enable verbose output for debugging
Usage: hype export [options]
Examples: hype export -format html hype export -f README.md -format html hype export -f README.md -format markdown -timeout=10s `
This allows you to see your compiled document either as a single markdown, or as an html document that you can preview in the browser.
To include a markdown file, use the include tag. This will run that markdown file through the hype.Parser being used and append the results to the current document.
The paths specified in the src attribute of the include are relative to the markdown file they are used in. This allows you to move entire directory structures around in your project without having to change references within the documents themselves.
The following code will parse the code/code.md and sourceable/sourceable.md documents and append them to the end of the document they were included in.
<include src="code/code.md"></include>
<include src="sourceable/sourceable.md"></include>source: docs/quickstart/includes.md
You can view the source for this entire readme in the .hype directory.
Here is the current structure that we are using to create this readme:
$ tree ./docs
./docs
├── badges.md
├── license.md
└── quickstart
├── hype.md
├── includes.md
└── src
├── broken
│ └── main.go
└── hello
└── main.go
4 directories, 6 filesThis repo uses the action to keep the README up to date.
For this action to work, you need to either configure your repo with specific permissions, or use a personal access token.
You need to give permission to your GitHub Actions to create a pull request in your GitHub repo settings (Settings -> Actions -> General).
Under Workflow Permissions
- Check
Allow GitHub Actions to create and approve pull requests. - Check
Read and write permissions
Alternately, you can use tokens to give permission to your action.
It is recommend to use a GitHub Personnal Acces Token like: ${{secrets.PAT}} instead of using ${{secrets.GITHUB_TOKEN}} in GitHub Actions.
The current action is set to only generate the readme on a pull request and commit it back to that same pull request. You can modify this to your own needs.
name: Generate README with Hype
on: [pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.event.pull_request.head.ref }}
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: "1.23.x"
cache-dependency-path: subdir/go.sum
- name: Install hype
run: go install github.com/gopherguides/hype/cmd/hype@latest
- name: Run hype
run: hype export -format=markdown -f hype.md > README.md
- name: Commit README back to the repo
run: |-
git rev-parse --abbrev-ref HEAD
git config user.name 'GitHub Actions'
git config user.email 'actions@github.com'
git diff --quiet || (git add README.md && git commit -am "Updated README")
git push origin ${{github.event.pull_request.head.ref}}source: .github/workflows/hype.yml
There are several issues that still need to be worked on. Please see the issues tab if you are interested in helping.
Hype by Gopher Guides LLC is licensed under Attribution-NonCommercial-ShareAlike 4.0 International
