https://github.com/petarov/nenu

A tiny, static site builder for your journal (Jekyll alternative)
https://github.com/petarov/nenu

jekyll site-generator static-site-generator static-website

Last synced: 2 months ago
JSON representation

A tiny, static site builder for your journal (Jekyll alternative)

• Host: GitHub
• URL: https://github.com/petarov/nenu
• Owner: petarov
• License: mit
• Created: 2020-03-22T20:26:03.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-25T12:14:47.000Z (almost 2 years ago)
• Last Synced: 2024-10-11T15:17:16.799Z (3 months ago)
• Topics: jekyll, site-generator, static-site-generator, static-website
• Language: Go
• Homepage: http://petarov.github.io/nenu
• Size: 126 KB
• Stars: 5
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
nenu

===================

[![build](https://github.com/petarov/nenu/workflows/CI%20Build/badge.svg)](https://github.com/petarov/nenu/actions?query=workflow%3A%22CI+Build%22)

[![goreport](https://goreportcard.com/badge/github.com/petarov/nenu)](https://goreportcard.com/report/github.com/petarov/nenu)

`пепи` - 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](http://petarov.github.io/nenu/)

# Installation

[Download binaries](https://github.com/petarov/nenu/releases) 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: ` - Post title

  * `subtitle: ` - Post subtitle. Optional.

  * `summary: ` - Post meta description. Optional.

  * `publish: ` - Default `true`. Set to `false` to skip generating this post. Optional.

See examples in [test-data](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](TODO.md) list to check what's ~~coming~~ missing.

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

# License

[MIT](LICENSE)