Quick Start
One page summary of how to start a new openkf project.
Requirements
Why Node.js?
openkf uses npm (included with Node.js) to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts.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.
Child theme
- Intended for novice to intermediate users
- Intended for minor customizations
- Easily update npm packages — including openkf
git clone https://github.com/openkf/website-child-theme.git my-openkf-site
Starter theme
- Intended for intermediate to advanced users
- Intended for major customizations
- Easily update npm packages
git clone https://github.com/openkf/website.git my-openkf-site
Help me choose
Not sure which one is for you? Pick the child theme.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 →