Chulbul

The Minimalistic Static Site Generator

Getting Started

New to Chulbul and want to start quickly with minimalistic setup ?

Install the latest version of chulbul using npm package manager or yarn distro using commands shown on right.

npm install chulbul --save
or
yarn add chulbul

Do you Know ?

Chulbul follows minimalistic way to provide the solution to extend the features we use plugins.

Chulbul uses HTML, CSS & JS and to reduce boilerplate code we use nunjucks as a templating engine

Hello World with Chulbul

const Chulbul = require("Chulbul");

Chulbul(__dirname, config)
    .listen(5000);

This will start the development server for you running on localhost where hello world page is waiting for you.

Aprart from that it creates four directories for you template, build, static, and docs

Features

Auto URL Routing

Chulbul routes url automatically by looking at directory structure of docs directory.

Versioning Enabled

You can version your documentation with less headache and simple version routing.

Lots of Plugins

Plugins to extends features easily you can even create your own plugin it's easy.