phistep / mdbl0g

A simple, file-based, markdown-driven blog engine *with* web interface.

mdbl0g

A simple, file-based, markdown-driven blog engine with web interface.

Features

• light-weight
• beautiful, minimalistic, HTML5 responsive default layout
• file based, no data base needed
• create, edit and delete in the web interface or upload files manually
• web interface with live preview
• no comments, no categories, no tags - just text*
• markdown formatting
• full text search
• RSS feed
• opt-out prettified URLs
• English and German localization
• simple and quick installer

*Customize with Plugins

You can easily add features to your mdbl0g by installing plugins. Just download one and drop it into the plugins/ directory. There are already some available at the mdbl0g Plugin Directory.

If you want to develop your own plugins, have a look at the Plugin API.

Installation

Requirements

You need at least PHP version 5.1.0, Apache mod_auth_basic for HTTP Basic Auth (Admin Interface) and optionally Apache mod_rewrite for Pretty URLs. Or any other web server that uses Apache configuration files and implements mod_auth_basic and mod_rewrite. You don't need any sort of database, because mdbl0g is a file based blog engine.

If you have no clue what all this means -- it will probably work ;) Just give it a shot!

Installation process

Download the mdbl0g files from GitHub and upload them to your server. You can also check out the repository with git which makes updating easier:

git clone git://github.com/Ps0ke/mdbl0g.git

Now point your browser to http://YOURDOMAIN.com/mdbl0g/install/ or where ever you uploaded the files. The installer will guide you through the simple installation process. When told to do so, delete the install/ directory and you are ready to go.

Import

Since the file format is very simple, you can easily export your existing blog to use the posts with mdbl0g. Here is a small script to import from Wordpress.

FAQ

Q: Isn't a file based blog really slow?

A: No. Network latency is a way bigger problem for performance as disc I/O. At least if you deal with a (for a blog) reasonable amount of data. I even tested the limits of mdbl0g, you can read about it at my (mdbl0g-driven) blog.

License

The MIT License:

Copyright (c) 2012 Philipp Stephan

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Powered by

• The beautiful 'Average' typeface by Eduardo Tunni (License: SIL Open Font License, 1.1) using Google's awesome Web Fonts API
• PHP Markdown 1.0.1o (License: BSD-style / GPL 2)
• showdown.js (License: BSD)
• PHP-like Javascript Date.format (License: MIT)

mdbl0g's Issues

Typo: sarte

"get me sarted" -> "get me started" (https://github.com/Ps0ke/mdbl0g/blob/master/install/step_0.php#L10)

Project Page

Run a modified version of the codebase as a project page. Fetch the READMEs from raw.github.com and generate posts automatically. Then allow users to create posts so they can try out the whole process. Delete the posts every now and then.

Specific Titles

You want the post title in the <title> when viewing a single post. Or the search query when viewing a result page. or the page number. and so on

Benchmark with many connections and searching

Create and run a benchmark, like the one for searching, but now with many clients hitting the page at the same time. This could be rather slow

Deny from all for plugins dir

Add Deny from all to the .htaccess of the plugins/ directory. First test if the plugins still work ;)

Own basic auth implementation

Write (and let audit) a own HTTP Basic Auth implementation (or even a own login form?)

PHP Documentation

Using this you could hide the delete/edit buttons when not logged in, greet the user with their username or write plugins making multi-author-blogging possible.

mdbl0g/admin/GET_PLUGINS_LINK doesn't work

HTML Error 404: Object not found

API localization

Provide a method to localize strings of plugins. Currently no idea how.

Move delete post link to edit page

Move the "delete post" link to the edit page of that post. reducing the clutter in the interface AND the possibility of accidentally deleting a post.

XML Code block

Is there a possibility to post XML Code into markdown, without editing all the "<" to "&lt" and ">" to "&gt" ?

Installer localization

Localize the installer maybe somehow?

Write thorough documentation

I hate to do this, but I want to write through documentation on theming, all available variables at each plugin hook and how to correctly theme the admin page to not break the plugin listing.

v1.1

New features shall be gathered in this release

Typo: abbonieren

German localization: "abbonieren" -> "abonnieren" (https://github.com/Ps0ke/mdbl0g/blob/master/core/strings/de_DE.php#L5)

Search form pretty URLs

Trying to redirect the search URLs. Details on Stack Overflow.

Make search case insensitive

search is case sensitive right now, that makes absolutely no sense!

`html_aside-list` hook `li`-problem

In the html_aside-list-hook the <li> has to go inside the foreach() obviously.

Remember: no umlauts in passwords

crypt/mod_basic_auth don't support umlauts in passwords. this is embarrassing, but I should mention it in the docs.