/motyl

Opinionated blog-aware static site generator written in Lua
  1. Lua 100.0%
Lua
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit 1004efa Aug 7, 2017 @fcambus fcambus Add some configuration and usage information in README
Permalink
Failed to load latest commit information.
examples Rename 'deploy' directory to 'public' Aug 7, 2017
src Rename 'deploy' directory to 'public' Aug 7, 2017
AUTHORS Remove all Twitter mentions Feb 9, 2017
LICENSE Bump copyright year Feb 7, 2017
README.md Add some configuration and usage information in README Aug 7, 2017
TODO Update TODO Aug 7, 2017

README.md

Description

Motyl is an opinionated blog-aware static site generator written in Lua. It uses Mustache as templating system, and all content is written in Markdown.

For the record, motyl means butterfly in Polish.

Features

  • Small and easy to understand code (only 131 sloc)
  • Minimal dependencies (only four Lua rocks)
  • Pages and posts written in Markdown
  • Templates are logic-less and use Mustache
  • Support for categories
  • Customizable URLs (constructed from filename)
  • Atom feed generator

Requirements

Motyl requires Lua 5.1+ and Make.

Lua modules

Motyl requires the following Lua modules:

  • LuaFileSystem
  • lunamark
  • lustache
  • lyaml

Installing dependencies via LuaRocks:

luarocks install luafilesystem
luarocks install lunamark
luarocks install lustache
luarocks install lyaml

Alternatively, those modules can be installed directly using binary packages.

Configuration

The 'examples' directory contains a sample site which can be used as a starting point.

Installing a theme

Clone the Chrysalide theme repository and place the files in the themes directory.

Usage

Simply run make to build the site, it will generate posts and pages into the public directory, and will also copy static assets.

License

Motyl is released under the BSD 2-Clause license. See LICENSE file for details.

Author

Motyl is developed by Frederic Cambus.

Resources

GitHub: https://github.com/fcambus/motyl