A fast clone of the Jekyll blogging engine, in Go
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.github Update docs to point to issues. Jul 9, 2017
cache Tests enable, disable cache Jul 23, 2017
collection Rename Page methods Sep 2, 2017
commands Follow go style guide re declaring empty slices Sep 2, 2017
config Emulate github-pages plugin Sep 1, 2017
docs Emulate github-pages plugin Sep 1, 2017
example Use MapSlice to preserve _config data order Aug 24, 2017
filters Follow go style guide re declaring empty slices Sep 2, 2017
frontmatter Follow go style guide re declaring empty slices Sep 2, 2017
pages Rename Page methods Sep 2, 2017
plugins Revise default-layout Sep 2, 2017
renderers Implement jekyll-default-layout plugin Sep 2, 2017
scripts scripts/compare only uses the basename in the dest Sep 2, 2017
server Better reload Aug 8, 2017
site Rename a couple of plugin methods Sep 2, 2017
tags include tag looks in $theme/_includes Jul 25, 2017
templates Use template.SetSourceLocation instead of adding fake whitespace Jul 9, 2017
utils More functional style implementation of installPlugins Sep 1, 2017
version Define jekyll.version to liquid Aug 14, 2017
.appveyor.yml move mingw install from init Jul 7, 2017
.dockerignore Docker Jul 15, 2017
.gitignore Docker Jul 15, 2017
.goreleaser-darwin.yml update goreleaser version varname target Jul 19, 2017
.goreleaser.yml update goreleaser version varname target Jul 19, 2017
.travis.yml Add go 1.9 to travis matrix Sep 1, 2017
CONTRIBUTING.md make install_dev_tools -> setup Jul 13, 2017
Dockerfile Docker Jul 15, 2017
LICENSE Create LICENSE Jun 11, 2017
Makefile Define jekyll.version to liquid Aug 14, 2017
README.md Doc another autogenerated header id incompat Aug 27, 2017
main.go Move cmd back to commands Jul 19, 2017



Gojekyll is a partially-compatible clone of the Jekyll static site generator, written in the Go programming language. It provides build and serve commands, with directory watch and live reload.

  Gojekyll Jekyll Hugo
Template language Liquid Liquid Go templates
Jekyll compatibility partial
Plugins some yes ?
Windows support
Implementation language Go Ruby Go


gojekyll build       # builds the site in the current directory into _site
gojekyll serve       # serve the app at http://localhost:4000; reload on changes
gojekyll help
gojekyll help build


Binary Downloads

  1. Ubuntu (64-bit) and macOS binaries are available from the releases page.
  2. [Optional] Highlight. To use the {% highlight %} tag, you need Pygments: pip install Pygments.
  3. [Optional] Themes. To use a theme, you need to install Ruby and bundler. Create a Gemfile that lists the theme., and run bundle install. The Jekyll theme instructions provide more detail, and should work for Gojekyll too.

From Source


  1. Install go (1) via Homebrew: brew install go; or (2) download.
  2. See items (2-3) under Binary Downloads, above, for optional installations.

First-time install:

go get github.com/osteele/gojekyll

Update to the latest version:

go get -u github.com/osteele/liquid github.com/osteele/gojekyll

[Optional] Install command-line autocompletion

Add this to your .bashrc or .zshrc:

# Bash:
eval "$(gojekyll --completion-script-bash)"
# Zsh:
eval "$(gojekyll --completion-script-zsh)"


This project is at an early stage of development.

It works on the GitHub Pages sites that I care about, and it looks credible on a spot-check of other Jekyll sites.

Current Limitations

Missing features:

Also see the detailed status below.

Other Differences

These will probably not change:

By design:

  • Plugins must be listed in the config file, not a Gemfile.
  • The wrong type in a _config.yml file – for example, a list where a string is expected, or vice versa – is generally an error.
  • Server live reload is always on.
  • serve --watch (the default) reloads the _config.yml and data files too.
  • serve generates pages on the fly; it doesn't write to the file system.
  • Files are cached in /tmp/gojekyll-${USER}, not ./.sass-cache


  • Markdown:
    • < and > inside markdown is interpreted as HTML. For example, This is <b>bold</b> renders as bold. This behavior matches the Markdown spec, but differs from Jekyll's default Kramdown processor.
    • The autogenerated id of a header that includes HTML is computed from the text of the title, ignoring its attributes. For example, the id of ## Title (<a href="https://example.com/path/to/details">ref</a>)) is #title-ref, not #title-https-example-path-to-details-ref.
    • Autogenerated header ids replace punctuation by the hyphens, rather than the empty string. For example, the id of ## Either/or is #either-or not #eitheror; the id of ## I'm Lucky is #i-m-lucky not #im-lucky.


  • An extensible plugin mechanism – support for plugins that aren't compiled into the executable.

Feature Checklist

  • Content
    • Front Matter
    • Posts
    • Static Files
    • Variables
    • Collections
    • Data Files
    • Assets
      • Coffeescript
      • Sass/SCSS
  • Customization
    • Templates
      • Jekyll filters
        • scssify
        • everything else
      • Jekyll tags
    • Includes
    • Permalinks
    • Pagination
    • Plugins – partial; see here
    • Themes
    • Layouts
  • Server
    • Directory watch
  • Commands
    • build
      • --source, --destination, --drafts, --future, --unpublished
      • --incremental, --watch, --force_polling, JEKYLL_ENV=production
      • --baseurl, --config, --lsi
      • --limit-posts
    • clean
    • help
    • serve
      • --open-uri, --host, --port
      • --incremental, –watch, --force_polling
      • --baseurl, --config
      • --detach, --ssl-* – not planned
    • doctor, import, new, new-theme – not planned
  • Windows


Bug reports, test cases, and code contributions are more than welcome.


Gojekyll uses these libraries:

Package Author(s) Usage License
github.com/jaschaephraim/lrserver Jascha Ephraim Live Reload MIT License
github.com/kyokomi/emoji kyokomi jemoji plugin emulation MIT License
github.com/osteele/liquid yours truly Liquid processor MIT License
github.com/pkg/browser pkg serve --open-url option BSD 2-clause "Simplified" License
github.com/radovskyb/watcher Benjamin Radovsky Polling file watch (--force_polling) BSD 3-clause "New" or "Revised" License
github.com/russross/blackfriday Russ Ross Markdown processing Simplified BSD License
github.com/sass/libsass Listed here C port of the Ruby SASS compiler MIT License
github.com/tdewolff/minify Taco de Wolff CSS minimization MIT License
github.com/wellington/go-libsass Drew Wells Go bindings for libsass ???
gopkg.in/alecthomas/kingpin.v2 Alec Thomas command-line arguments MIT License
gopkg.in/yaml.v2 Canonical YAML support Apache License 2.0

In addition, the following pieces of text were taken from Jekyll and its plugins. They are used under the terms of the MIT License.

Source Use Description
Jekyll template documentation test cases filter examples
jekyll help command gojekyll help text help text
jekyll-feed plugin plugin emulation feed.xml template
jekyll-redirect-from plugin plugin emulation redirect page template
jekyll-sitemap plugin plugin emulation sitemap template
jekyll-seo-tag plugin plugin emulation feed template

The theme for in-browser error reporting was adapted from facebookincubator/create-react-app.

The gopher image in the testdata directory is from Wikimedia Commons. It is used under the Creative Commons Attribution-Share Alike 3.0 Unported license.

In addition to being totally and obviously inspired by Jekyll and its plugins, Jekyll's solid documentation was indispensible --- especially since I wanted to implement Jekyll as documented, not port its source code. The Jekyll docs were always open in at least one tab during development.


Hugo is the pre-eminent Go static site generator. It isn't Jekyll-compatible (-), but it's highly polished, performant, and productized (+++).

jkl is another Go clone of Jekyll. If I'd found it sooner I might have started this project by forking that one. It's got a better name.

Liquid is a pure Go implementation of Liquid templates, that I finally caved and wrote in order to use in this project.

Jekyll, of course.