Skip to content

petarov/nenu

Repository files navigation

nenu

build goreport

пепи - A tiny static site generator for your journal.

  • Binary executable without additional dependencies
  • Drop-in replacement for Jekyll markdown posts
  • One YAML config file
  • Archive, atom feed and custom themes support

See Demo

Installation

Download binaries for Linux, macOS or Windows.

Create a new configuration file:

cp ./config.yml.tpl config.yml

Make sure the url, title and description are specified.

Usage

Generate web site contents into an output folder called _site using the markdown files from _posts. By default, the website uses the blazer theme:

nenu_linux_amd64 -p _posts -o _site

Specify another theme to use:

nenu_linux_amd64 -p _posts -o _site -t themes/my-custom-theme

Markdown post meta params

  • title: <value> - Post title
  • subtitle: <value> - Post subtitle. Optional.
  • summary: <value> - Post meta description. Optional.
  • publish: <true|false> - Default true. Set to false to skip generating this post. Optional.

See examples in test-data.

Development

пепи is a tool that should remain as small as possible. Adding new features is nice, but not really the goal of the project.

Refer to the TODO list to check what's coming missing.

If you'd like to add your own language locale, check config/locales.go.

License

MIT