Quick Start

One page summary of how to start a new openkf project.

Requirements

openkf uses npm to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts:

  • Download and install Node.js (it includes npm) for your platform.

Start a new openkf project

Create a new site, change directories, install dependencies, and start development server.

Create a new site

openkf is available as a child theme, and a starter theme:

  • Use the openkf child theme, if you do not plan to customize a lot, and/or need future openkf updates.
  • Use the openkf starter theme, if you plan to customize a lot, and/or do not need future openkf updates.

Not quite sure? Use the openkf child theme.

openkf child theme 

git clone https://github.com/openkf/website-child-theme.git my-openkf-site

openkf starter theme 

git clone https://github.com/openkf/website.git my-openkf-site

Change directories 

cd my-openkf-site

Install dependencies 

npm install

Start development server 

npm run start

openkf will start the Hugo development webserver accessible by default at http://localhost:1313. Saved changes will live reload in the browser.

Other commands

openkf comes with commands for common tasks. Commands →

← Introduction
Commands →