Skip to main content

Keystone logo

Why Keystone?

Keystone is a static-site generator ideal for quickly building small websites. No setup required, and a collection of handy features are enabled by default.

Features

  • Easy install & setup, one command and ready to go
  • Auto-refresh development server
  • Use templates and reusable partials/imports, with slots
  • Automatic routing, just upload /public and you're ready to go
  • Babel, SCSS, & Markdown support enabled by default, source maps in development mode
  • JS & CSS minifying and bundling (with Rollup)
  • Dynamic link loading (no page reload)
  • Search index file generator, for easy website searching

Getting Started

Install​

Create a new directory and run the following command to setup Keystone, package.json, & git. Node 14.x.x required.

$  npm install keystone-ssg

Great, you're installed!

Development server​

Start the Keystone development server, and then go to http://localhost:8080 to see the example website.

$ npm run dev

What's next?

Read the rest of the tutorial on our GitHub page!