<p align="center"> <img width="250" src="/kulfon-static-site-generator-logo.png"> </p> <h1 align="center"> <a href="https://kulfon.org">Kulfon</a> </h1> <p align="center"> <b>Static Site Generator for The Rest of Us</b> </p> <br> <p align="center"> <a href="https://www.npmjs.com/package/kulfon"><img src="https://img.shields.io/npm/v/kulfon.svg?style=for-the-badge" alt="Kulfon Package on NPM"></a> <a href="https://www.npmjs.com/package/kulfon"><img src="https://img.shields.io/npm/dm/kulfon.svg?style=for-the-badge" alt="Kulfon Package on NPM"></a> </p>

Kulfon /kuːl fəʊn/ is a one command, JavaScript static site generator inspired by Hugo. It combines data sources with templates to tranform them into HTML pages at once. It supports Nunjucks, Markdown and Org Mode out-of-the-box.

This software is still under active development and not feature complete or ready for consumption by anyone other than software developers.

- Kulfon, Kulfon, co z Ciebie wyrośnie ?! martwię się już od tygodnia!

- Przestań!

While you're hesitating, listen to this wonderful Kulfon song!

Demo

Why Kulfon?

There is a ton of static site generators out there. Here are few points to convince you to try Kulfon

one-command tool, similar to Hugo, but written in JavaScript, so it's easier to integrate additional JavaScript libraries or stylesheets
solid foundation with carefully selected tools to produce smaller websites faster as The Average Webpage Is Now the Size of the Original Doom
Rollup for bundling javascripts
Sass for stylesheets
Nunjucks for views (a simple, designer friendly HTML-based syntax)
written in ES6/ES2015
Org Mode support
Markdown support
unified approach to external dependencies management with either unpkg or Yarn
HTTP/2 ready

Installation

npm install -g kulfon

Getting started

Once Kulfon is installed, you will have access to the kulfon command. First, let's create a new project:

kulfon new <my-project-name>

Now enter the directory

cd <my-project-name>

and run kulfon's server

kulfon serve

It creates public directory with compiled content (this directory should be ignored). Go to http://localhost:3000 to check your website.

For more commands, just type

kulfon

Visit Getting Started for more.

Roadmap

Kulfon keeps track of the upcoming fixes and features on GitHub Projects: Kulfon Roadmap

Websites that use Kulfon

If your website is using Kulfon, feel free to make a PR to add it to this list; please add the new entries at the top.

https://nukomeet.com
https://zaiste.net
https://kulfon.org

Bug reports

We use Github Issues for managing bug reports and feature requests. If you run into problems, please search the issues or submit a new one here: https://github.com/kulfonjs/kulfon/issues

Detailed bug reports are always great; it's event better if you are able to include test cases.

Kulfon

Install / Use

README