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/).
|
|
|
|
|
|
2017-03-24 15:53:10 +00:00
|
|
|
**NOTE:** Mebe is tailored for my own use at [my blog](https://blog.nytsoi.net/). Some
|
|
|
|
|
things are made configurable, but some are not and usage instructions are currently very
|
|
|
|
|
scarce. So proceed with caution.
|
|
|
|
|
|
2015-11-18 21:37:36 +00:00
|
|
|
The engine consists of two parts:
|
2015-05-14 20:58:25 +00:00
|
|
|
|
|
|
|
|
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`
|
2015-11-18 21:37:36 +00:00
|
|
|
* Copy `config/*.exs.dist`, removing the `.dist` ending and go through the configs.
|
2017-03-24 15:53:10 +00:00
|
|
|
* `npm install && mix frontend.build` to build the frontend. Use `MIX_ENV=prod` to build
|
|
|
|
|
minified files.
|
2015-12-10 20:55:36 +00:00
|
|
|
* Put some content into the data path you specified, at least a `menu` file.
|
2015-05-14 20:58:25 +00:00
|
|
|
* `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
|
2015-12-29 19:41:59 +00:00
|
|
|
* Use custom style CSS by defining path in settings
|
2015-09-14 19:45:53 +00:00
|
|
|
* Expect script for refreshing blog from the command line
|
2015-11-18 21:37:36 +00:00
|
|
|
* Splitting of posts so that only the beginning will be shown in a list view or feed
|
2015-06-28 20:56:15 +00:00
|
|
|
|
|
|
|
|
## Possible future features
|
|
|
|
|
|
|
|
|
|
* Tests
|
|
|
|
|
* User's guide
|
|
|
|
|
* Sitemap
|
2015-09-14 18:26:37 +00:00
|
|
|
|
|
|
|
|
## Licence
|
|
|
|
|
|
|
|
|
|
Mebe is open source and licensed under the MIT Expat licence. Check the [LICENCE](LICENCE) file for details.
|
