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

38 lines
1.2 KiB
Markdown
Raw Normal View History

2015-05-14 20:58:25 +00:00
# Mebe
Mebe -- _the Minimalistic Elixir Blog Engine_ -- is a simple blog engine written in [Elixir](https://elixir-lang.org),
using the [Phoenix Framework](http://www.phoenixframework.org/).
The engine consists of two parts, both in the `apps/` directory:
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 `*.exs.dist`, removing the `.dist` ending and go through the configs.
* `npm install && bower install && gulp` to build the frontend.
* `mix phoenix.server` to run the development server.
2015-06-28 20:56:15 +00:00
## Features
* Blog by just writing Markdown files, no admin UI
* Automatic yearly, monthly and tag archives
* Disqus commenting
2015-08-05 21:13:02 +00:00
* RSS feeds for all posts and for tags
2015-09-13 19:34:13 +00:00
* Override templates by putting replacements into a directory
* Expect script for refreshing blog from the command line
2015-06-28 20:56:15 +00:00
## Possible future features
* Tests
* User's guide
* Sitemap
2015-09-14 18:26:37 +00:00
* Override styles more easily
## Licence
Mebe is open source and licensed under the MIT Expat licence. Check the [LICENCE](LICENCE) file for details.