kartoffeldruck

An intentionally non-pluggable, all-in-one, opinionated static site generator. Built with the zen of kartoffeldruck.

kartoffeldruck image

Features

kartoffeldruck is a full fledged site generation solution. An incomplete list of features:

Markdown and Nunjucks templating support
Front matters
Pagination
Draft posts
Fetch tags and generate tag clouds
Generate table of contents
Custom urls (slugify, ...)
Custom helpers
Custom content processors

We intentionally do not provide any css processing pipelines or asset copy utilities. Use other tools that do the job.

Resources

Usage

Place a kartoffeldruck.js file in your current project directory:

/**
 * @param { import('kartoffeldruck').Kartoffeldruck } druck
 */
module.exports = async function(druck) {

  // initialize the kartoffeldruck instance
  // you may specify (global) template locals
  // as well as the place for templates, pages, assets and dest more
  druck.init({
    locals: {
      site: {
        title: 'My Site'
      }
    }
  });

  await druck.generate({
    source: '*.md',
    dest: ':name/index.html'
  });
};

Install the kartoffeldruck globally via npm:

$ npm i -g kartoffeldruck

Run kartoffeldruck in the current directory. It will pick up your runner file and generate the site into the dist directory (or whatever is specified as dest via druck.init(options).

$ kartoffeldruck
Generating site in /some-dir
Done

Alternatively, run kartoffeldruck directly via npx:

$ npx kartoffeldruck

Check out the example project to learn more about what is possible with the library.

Alternatives

You would like to spend hours composing a site generation solution yourself? Try out metalsmith. You would rather like to use Ruby anyway? Try jekyll. You want to experiment? Role your own.

Grunt Integration

Simply add the following task to your Gruntfile.js:

grunt.registerTask('kartoffeldruck', function() {
  var done = this.async();

  var {
    Kartoffeldruck
  } = require('kartoffeldruck');

  Kartoffeldruck.run({
    logger: {
      debug: grunt.log.ok,
      info: grunt.log.ok
    }
  }).then(
    () => done(),
    (err) => done(err)
  );
});

It will pick up your local kartoffeldruck.js file and generate the blog from there.

License

MIT

nikku / kartoffeldruck