Skip to content
/ chewup Public

The world's most barebones static site generator, sloppily developed in record time

License

Notifications You must be signed in to change notification settings

gbl08ma/chewup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

chewup

The world's most barebones static site generator, sloppily developed in record time.

Written in Go, it's mainly a shortcut into using Go's template engine to produce HTML for a static website.

Installation

go get -u github.com/gbl08ma/chewup

(Feel free to fork to add your favorite dependency management solution, etc. Don't complain: did you miss the "record time" part?)

Usage

chewup -in input -out output

If the input folder is not specified, it will be the working directory. If the output folder is not specified (but the input folder is), it will be the working directory. If neither is specified, the input folder will be the working directory, and the output folder will be generated inside the input folder.

If you are unsure, by using the flag -test Chewup will execute and show the input and output directories it will use, without writing anything.

Chewup expects to find files with extension .html and .template inside the input directory. It will look for those files recursively. All matching files will be evaluated by Go's html/template (Godoc) and they will be associated with each other, which means you can invoke other files from each template (which is the whole point of this program, really).

Each .html file will be executed, with the result (over)writing the corresponding file in the output directory, with the same relative path and name. .template files are reserved for inclusion by other files.

You can use the -test flag to check the syntax of the input without damaging good output files from a previous run.

Chewup-specific template features

To pass multiple values in template invocations, Chewup includes a dict template function.

You can use it like this:

{{ template "header.template" dict "Title" "Page title" "Description" "Description of the page" }}

And, on header.template, you would retrieve the values like this, as if they were part of the struct passed to template.Execute:

<h1>{{ .Title }}</h1>
<p>{{ .Description }}</p>

(Thanks to this StackOverflow answer for this trick)

This can be used, for example, to set the title of the page in the header template, or the currently selected item in the navigation bar template, etc.

License

MIT

About

The world's most barebones static site generator, sloppily developed in record time

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages