motyl

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

README.md (1978B)


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