# Gojekyll [![Build Status](https://travis-ci.org/osteele/gojekyll.svg?branch=master)](https://travis-ci.org/osteele/gojekyll) [![Go Report Card](https://goreportcard.com/badge/github.com/osteele/gojekyll)](https://goreportcard.com/report/github.com/osteele/gojekyll) [![Coverage Status](https://coveralls.io/repos/github/osteele/gojekyll/badge.svg?branch=master)](https://coveralls.io/github/osteele/gojekyll?branch=master) Gojekyll is a re-implementation of the [Jekyll](https://jekyllrb.com) static site generator, in the [Go](https://golang.org) programming language. - [Gojekyll](#gojekyll) - [Installation](#installation) - [Usage](#usage) - [Limitations](#limitations) - [Other Differences](#other-differences) - [Timings](#timings) - [Feature Status](#feature-status) - [Contributing](#contributing) - [Credits](#credits) - [Related](#related) - [License](#license) ## Installation 1. [Install go](https://golang.org/doc/install#install). On macOS running Homebrew, `brew install go` is easier than the linked instructions. 2. `go get -u osteele/gojekyll/cmd/gojekyll` 3. To use the `{% highlight %}` tag, ou need Pygments. `pip install Pygments`. ## Usage ```bash gojekyll build # builds the site in the current directory into _site gojekyll serve # serve the app at http://localhost:8080 gojekyll help gojekyll help build ``` ## Limitations Major missing features: - Themes - Excerpts - Pagination - Math - Plugins, except `jekyll-avatar` and `jekyll-gist` - Site variables: `html_pages`, `html_files`, and `tags` - CSV and JSON data files. - Jekyll filters: `group_by_exp`, `pop`, `shift`, `cgi_escape`, `uri_escape`, `scssify`, and `smartify` The [feature parity](https://github.com/osteele/gojekyll/projects/1) board gives a more complete list of differences between gojekyll and Jekyll. Also see the [Go Liquid README](https://github.com/osteele/liquid/#status) for a current list of limitations in the Liquid engine. ## Other Differences These will probably not change. - `serve` generates pages on the fly; it doesn't write to the file system. - Files are cached to `/tmp/gojekyll-${USER}`, not `./.sass-cache` - Server live reload is always on. - The server reloads the `_config.yml` (and the rest of the site) when that file changes. - An extensible plugin mechanism. Emulations of commonly-used plugins can be added to the repo. ## Timings `[go]jekyll -s jekyll/docs build` on a late-2015 MacBook Pro, running current versions of everything as of 2017-07-01. | Executable | Options | Time | |------------|-----------------------------|--------| | jekyll | | 18.53s | | gojekyll | single-threaded; cold cache | 6.85s | | gojekyll | single-threaded; warm cache | 0.61s | | gojekyll | multi-threaded | 0.34s | This isn't a fair comparison but Gojekyll doesn't use all the plugins that Jekyll does. In particular, `jekyll-mentions` parses each page's HTML. This could slow Gojekyll down once it's added. There's currently no way to disable concurrency or the cache. They were switched off by re-building the executable to produce these timings. In the multi-threaded case, whether the cache is warm or cold doesn't seem to matter. The cache is for calls to Pygments (via the `highlight` tag). For another site, SASS is greater overhead. This is another candidate for caching, but with multi-threading it may not matter. ## Feature Status - [ ] Content - [x] Front Matter - [ ] Posts - [x] Categories - [ ] Tags - [x] Drafts - [x] Future - [x] Related - [x] Static Files - [x] Variables - [x] Collections - [ ] Data Files - [ ] CSV - [ ] JSON - [x] YAML - [ ] Assets - [ ] Coffeescript - [x] Sass/SCSS - [ ] Customization - [x] Templates - [ ] Jekyll filters - [ ] `group_by_exp` `pop` `shift` `cgi_escape` `uri_escape` `scssify` `smartify` - [x] everything else - [x] Jekyll tags - [x] `include` - [x] `include_relative` - [x] `link` - [x] `post_url` - [x] `highlight` - [x] Includes - [x] `include` parameters - [x] `include` variables (e.g. `{% include {{ expr }} %}`) - [x] Permalinks - [ ] Pagination - [ ] Plugins - [x] `jekyll-avatar` - [ ] `jekyll-coffeescript` - [x] `jekyll-gist` (ignores `noscript: false`) - [x] `jekyll-live-reload` (always on) - [ ] `jekyll-paginate` - [ ] Themes - [x] Layouts - [x] Server - [x] Directory watch - [ ] Commands - [x] `build` - [x] `--source`, `--destination`, `--drafts`, `--future`, `--unpublished` - [ ] `--config`, `--baseurl`, `--lsi`, `--watch`, etc. - [ ] not planned: `--force-polling`, `--limit-posts`, `--incremental`, `JEKYLL_ENV=production` - [x] `clean` - [ ] `doctor` - [x] `help` - [ ] `import` - [ ] `new` - [ ] `new-theme` - [x] `serve` - [x] `--open-uri` - [ ] `--detach`, `--host`, `--port`, `--baseurl` - [ ] not planned: `--incremental`, `--ssl`-* - [ ] Windows ## Contributing Bug reports, test cases, and code contributions are more than welcome. Please refer to the [contribution guidelines](./CONTRIBUTING.md). ## Credits Gojekyll uses these libraries: | Package | Author(s) | Description | License | |--------------------------------------------------------------------------------|--------------------------------------------------------|-------------------------------------------------------|-----------------------------------| | [github.com/jaschaephraim/lrserver](https://github.com/jaschaephraim/lrserver) | Jascha Ephraim | Live Reload server | MIT | | [github.com/osteele/liquid](https://github.com/osteele/liquid) | yours truly | Liquid processor | MIT | | [github.com/pkg/browser](https://github.com/pkg/browser) | [pkg](https://github.com/pkg) | The `serve -o` option to open the site in the browser | BSD 2-clause "Simplified" License | | [github.com/russross/blackfriday](https://github.com/russross/blackfriday) | Russ Ross | Markdown processor | Simplified BSD License | | [github.com/sass/libsass](https://github.com/sass/libsass) | Listed [here](https://https://github.com/sass/libsass) | C port of the Ruby SASS compiler | MIT | | [github.com/wellington/go-libsass](https://github.com/wellington/go-libsass) | Drew Wells | Go bindings for **libsass** | ??? | | [gopkg.in/alecthomas/kingpin.v2](https://github.com/alecthomas/kingpin) | Alec Thomas | command line and flag parser | MIT | | [gopkg.in/yaml.v2](https://github.com/go-yaml/yaml) | Canonical | YAML support | Apache License 2.0 | In addition to being totally and obviously inspired by Jekyll, Jekyll's *documentation* was solid and indispensible. Many of the filter test cases are taken directly from the Jekyll documentation, and during development the [Jekyll docs](https://jekyllrb.com/docs/home/) were always open in at least one tab. The text for `gojekyll help` was taken from the output of `jekyll help`. The gopher image in the `testdata` directory is from [Wikimedia Commons](https://commons.wikimedia.org/wiki/File:Gophercolor.jpg). It is used under the [Creative Commons Attribution-Share Alike 3.0 Unported license](https://creativecommons.org/licenses/by-sa/3.0/deed.en). ## Related [Hugo](https://gohugo.io) is *the* pre-eminent Go static site generator. It isn't Jekyll-compatible (-), but it's extraordinarily polished, performant, and productized (+++). [Liquid](https://github.com/osteele/liquid) is a Go implementation of Liquid templates. I wrote it for gojekyll, but it's implemented as a standalone library. [Jekyll](https://jekyllrb.com), of course. ## License MIT