A CLI tool for working with static site generators. A Cali App
This application provides a number of tools related to static site generation, all running in docker containers from a single binary file. Rather than go through the hassle of installing Ruby, rake, bundler, jekyll, python, proselint, gulp, etc. you only need the one single binary file and to have docker installed.
Staticli provides the tools that its developers regularly use to work with static websites. We're open to pull requests for additional tooling, but it must be relevant to static web site development (feel free to create your own Cali app for other tools). The tools we currently provide include:
- bundle and rake for working with Jekyll and github-pages websites
- github-release for releasing a new version of something to github
- gulp for compiling scss to css
- heroku for deploying sites to heroku
- hugo for providing the hugo static site generator
- jekyll for creating new jekyll sites
- mkdocs, a fast and simple static site generator that's geared towards building project documentation
- npm and npx for managing and running node packages
- ponysay for nice notifications
- proselint for checking files for best practises in writing
- python simplehttp for serving the current directory over http
- surge for deploying sites to surge.sh
- Install Docker (
brew cask install dockeron MacOS)
- Download the correct binary, move it into your $PATH as
staticliand make it executable
See this asciicast to watch it being installed
From this one single binary you can now run rake tasks to preview and validate Jekyll blogs, run proselint to check for best practises in writing, and run gulp to turn sass into css. All of this happens inside docker containers, so you don't actually need to install any extra tooling. You will need an internet connection the first time you run each subcommand in order to download the container though.
For any command which exposes a port (typically an http server to render a site) we default to exposing this on port 2000. You can override this by setting
--port 4000 or
-p 4000 to listen on (for example) port 4000 instead.
staticli ag runs Silver Searcher in the current directory.
staticli rake runs
bundle install --path=_vendor && bundle exec rake $@ in the current directory. This assumes the default rake task runs preview on a Jekyll site, and therefore exposes port 4000 on the container as port 2000 on the host. This means you can browse to http://127.0.0.1:2000 to view the site. You can change the port exposed on the host by setting
--port 4000 to use (for example) port 4000.
staticli bundle runs
bundle in the current directory. Since the
rake command installs required gems anyway, this command is mostly useful as a way of upgrading gems.
staticli gulp runs the gulp watch task. You can add
-t foo to run the foo task instead.
staticli heroku runs the Heroku cli, and takes any parameters and subcommands you need (uses ~/.netrc for authentication)
staticli hugo runs the hugo static site generator
staticli mkdocs new . creates a new static website for project documentation,
staticli mkdocs serve will serve it (though note you'll need to set dev_addr)
staticli npm runs npm, the node package manager, and
staticli npx runs npx from it
staticli ponysay runs ponysay, a cowsay replacement for ponies. Whilst this isn't strictly speaking a static site generator, it can be useful for notifying that we've finished generating a static site
staticli proselint README.md runs proselint against the file README.md to check for best practises in writing.
staticli simplehttp runs Python SimpleHTTP in the current directory.
staticli surge runs surge, allowing you to deploy the current directory to a surge.sh site.
staticli github-release for releasing something to github (see the Makefile for how this is used, it's probably not that helpful except for releasing new versions of staticli)
You can also see what version of staticli you are running with
staticli version which will also tell you about any available updates if you are online. If there are available updates you can get the latest version with
staticli update. You can also use
staticli update to update all of the local Docker images that Staticli uses by passing in
See this asciicast to see proselint being used for the first time.
Travis will automatically build and release new versions upon a new tag being pushed. When you want to create a new release, create a new tag against the master branch (incrementing as per the SemVer standard) and then push it.