Code Monkey home page Code Monkey logo

motyl's Introduction


             :::::::::::::::::::
             :::   _______   :: ________ ____.  ______.    .____.
             :::  .\   _  \____.\  _.  /.\   |_\\     |----|    |
             :::  |    |  .    |   \|   |    _/---    |    |    |_
             :::  |    |\_|    |    :   |    |    \___     |      \
             :::  |    |  |____|________|_____    | //____/|______/ 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 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.

Resources

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

motyl's People

Contributors

fcambus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

motyl's Issues

metki = tag

Czy metki działaja?
da się opisać wpis za pomocą kilku metek?

3-Clause BSD License

Hi Frederic,

I've noticed that you had copied the license verbatim - I'm pretty sure you can remove/change THE REGENTS from it ;^)

... or change it altogether to 2-clause, MIT or ISC one :^)

Regards,

Raf

Change markdown parser

currently kramdown is the default parser:

motyl/bin/motyl

Lines 16 to 20 in 4585fff

require 'date'
require 'fileutils'
require 'kramdown'
require 'mustache'
require 'yaml'

however this can cause some issues, as kramdown is quite different from
CommonMark/GFM:

and the kramdown author is unwilling or unable to fix these issues, for several
years now. after some hand wringing i discovered that a proper commonmark
implementation is available:

https://github.com/jekyll/jekyll-commonmark

No themes?

It appears there are no themes in the source, so the bundled example doesn't build. Are you planning on including themes in this repo?

Error syntax in header.mustache

Hi,

Thank you for this static site generator.

I'm trying to custom the menu with a new theme. Here the original html menu:

		<ul>
			<li class="current_page_item"><a href="#" accesskey="1" title="">Services</a></li>
			<li><a href="#" accesskey="2" title="">Our Clients</a></li>
			<li><a href="#" accesskey="3" title="">About Us</a></li>
			<li><a href="#" accesskey="4" title="">Careers</a></li>
			<li><a href="#" accesskey="5" title="">Contact Us</a></li>
		</ul>

In header.mustache, I tried to insert these lines:

xyz

But I have an error :

/var/lib/gems/2.7.0/gems/mustache-1.1.1/lib/mustache/parser.rb:286:in `error': Unclosed section "sitepages" (Mustache::Parser::SyntaxError)
Line 34
{{#site.pages}}

Which syntax is correct ?

Best wishes

"luarocks install lyaml" encounter error,how to fix it?

hi.

root@localhost:/usr/local/motyl-site/examples# luarocks install lyaml
Installing http://luarocks.org/repositories/rocks/lyaml-6.1.1-4.src.rock...
Using http://luarocks.org/repositories/rocks/lyaml-6.1.1-4.src.rock... switching to 'build' mode
Archive: /tmp/luarocks_luarocks-rock-lyaml-6.1.1-4-2306/lyaml-6.1.1-4.src.rock
inflating: lyaml-6.1.1-4.rockspec
extracting: v6.1.1.zip

Error: Could not find expected file libyaml.a, or libyaml.so, or libyaml.so.* for YAML -- you may have to install YAML in your system and/or pass YAML_DIR or YAML_LIBDIR to the luarocks command. Example: luarocks install lyaml YAML_DIR=/usr/local
root@localhost:/usr/local/motyl-site/examples#

tks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.