Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fcambus/motyl
Opinionated blog-aware static site generator
https://github.com/fcambus/motyl
Last synced: 3 months ago
JSON representation
Opinionated blog-aware static site generator
- Host: GitHub
- URL: https://github.com/fcambus/motyl
- Owner: fcambus
- License: bsd-2-clause
- Created: 2016-02-25T22:39:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-28T12:38:23.000Z (over 2 years ago)
- Last Synced: 2024-04-22T02:15:05.697Z (7 months ago)
- Language: Ruby
- Homepage:
- Size: 70.3 KB
- Stars: 78
- Watchers: 6
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - fcambus/motyl - Opinionated blog-aware static site generator (others)
README
```
:::::::::::::::::::
::: _______ :: ________ ____. ______. .____.
::: .\ _ \____.\ _. /.\ |_\\ |----| |
::: | | . | \| | _/--- | | |_
::: | |\_| | : | | \___ | \
::: | | |____|________|_____ | //____/|______/ H7
- - ::: -`----' --- ... ----------- `----' ---------------- -- -
::: :::
:::::::::::::::::::
```
## Description
Motyl is an opinionated blog-aware static site generator written in Ruby.
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 codebase
- Minimal dependencies (only three gems)
- Pages and posts written in Markdown
- Templates are logic-less and use Mustache
- Support for multiple categories per post
- Syntax highlighting (using Rouge)
- Customizable URLs (constructed from filename)
- Atom feed generator
## Requirements
### Ruby modules
Motyl requires the following Ruby modules:
- kramdown
- mustache
- rouge
Installing dependencies via gem:
gem install kramdown mustache rouge
Alternatively, those modules can be installed directly via the operating
system's package manager.
## Configuration
The 'examples' directory contains a sample site which can be used as a
starting point.
### Installing a theme
Clone the [Chrysalide](https://github.com/fcambus/chrysalide) theme repository
and place it in the `themes` directory.
## Usage
Simply run `motyl` 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.
- Site: https://www.cambus.net
## Resources
GitHub: https://github.com/fcambus/motyl