This repository has been archived on 2024-06-16. You can view files and clone it, but cannot push or open issues or pull requests.
mebe/README.md
2015-12-29 21:41:59 +02:00

1.3 KiB

Mebe

Mebe -- the Minimalistic Elixir Blog Engine -- is a simple blog engine written in Elixir, using the Phoenix Framework.

The engine consists of two parts:

  1. MebeEngine, which handles parsing the data files into an ETS (Erlang Term Storage) in-memory database, and
  2. MebeWeb, which uses the Phoenix Framework to serve the blog data to clients.

Installation for development

  • git clone
  • Copy config/*.exs.dist, removing the .dist ending and go through the configs.
  • npm install && gulp to build the frontend.
  • Put some content into the data path you specified, at least a menu file.
  • mix phoenix.server to run the development server.

Features

  • Blog by just writing Markdown files, no admin UI
  • Automatic yearly, monthly and tag archives
  • Disqus commenting
  • RSS feeds for all posts and for tags
  • Override templates by putting replacements into a directory
  • Use custom style CSS by defining path in settings
  • Expect script for refreshing blog from the command line
  • Splitting of posts so that only the beginning will be shown in a list view or feed

Possible future features

  • Tests
  • User's guide
  • Sitemap

Licence

Mebe is open source and licensed under the MIT Expat licence. Check the LICENCE file for details.