motyl

Opinionated blog-aware static site generator written in Ruby
Log | Files | Refs | README | LICENSE

README.md (1456B)


      1 ## Description
      2 
      3 Motyl is an opinionated blog-aware static site generator written in Ruby.
      4 It uses Mustache as templating system, and all content is written in Markdown.
      5 
      6 For the record, motyl means butterfly in Polish.
      7 
      8 ## Features
      9 
     10 - Small and easy to understand codebase
     11 - Minimal dependencies (only three gems)
     12 - Pages and posts written in Markdown
     13 - Templates are logic-less and use Mustache
     14 - Support for multiple categories per post
     15 - Syntax highlighting (using Rouge)
     16 - Customizable URLs (constructed from filename)
     17 - Atom feed generator
     18 
     19 ## Requirements
     20 
     21 ### Ruby modules
     22 
     23 Motyl requires the following Ruby modules:
     24 
     25 - kramdown
     26 - mustache
     27 - rouge
     28 
     29 Installing dependencies via gem:
     30 
     31 	gem install kramdown mustache rouge
     32 
     33 Alternatively, those modules can be installed directly via the operating
     34 system's package manager.
     35 
     36 ## Configuration
     37 
     38 The 'examples' directory contains a sample site which can be used as a
     39 starting point.
     40 
     41 ### Installing a theme
     42 
     43 Clone the [Chrysalide](https://github.com/fcambus/chrysalide) theme repository
     44 and place it in the `themes` directory.
     45 
     46 ## Usage
     47 
     48 Simply run `motyl` to build the site, it will generate posts and pages into
     49 the `public` directory, and will also copy static assets.
     50 
     51 ## License
     52 
     53 Motyl is released under the BSD 2-Clause license. See `LICENSE` file
     54 for details.
     55 
     56 ## Author
     57 
     58 Motyl is developed by Frederic Cambus.
     59 
     60 - Site: https://www.cambus.net
     61 
     62 ## Resources
     63 
     64 GitHub: https://github.com/fcambus/motyl