Skip to content

Stephan123/markdown_blog

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MarkdownBlog

MarkdownBlog is a lightweight blog software written in php and twitter bootstrap. Its purpose is to provide a easy way to share your thoughts without any database or special setup needed. The content of the website can be provided in easy to use markdown files (*.md) instead.

Features

  • Dynamic setup of your blog or website with simple configuration files but without any need of programming.
  • Support for (remote) markdown and HTML files
  • Easy to build navigation, including the ability to link external sites
  • Different views generated with your markdown or html files:
    • Single pages to show special content like 'Contact' or 'About'.
    • Remote pages to show content hosted on an onther server (e.g. your favourite GitHub project).
    • List of markdown files (the sample usecase of a blog)
    • Grouping of topics in a dynamicly generated dropdown menue.
  • Full responsive design due to the use of Twitter Bootstrap.
  • Syntax highlighting for both HTML and markdown
  • Build-in Gallery, including a lazy-load slider
  • Dynamic image resize to minimize network traffic
  • Extended support for blogs
    • Search for categories
    • Display content on several pages to ensure fast loading

Quick start

  1. Download markdown.zip and extract the archive into your server's web folder.
  2. Edit your webservers DocumentRoot to point at the projects public folder
  3. Modify the config/general.ini to personalize your website/blog. A sample configuration is provided in the config/general.ini.sample.
  4. Copy your *.md files on the server (e.g. public/content/ and provide their location in the config/config.ini.
  5. Make sure the server has read and execution access to all linked markdown files.
  6. Share your thoughts and enjoy!

For detailed information see the documentation.

Docker

Markdown Blog provides a Dockerfile for a easy installation.

For a test you can follow these steps:

  1. Download markdown.zip and extract your local hard disk
  2. docker build -t YOUR_NAME/mdblog . in the MarkdownBlog folder (where YOUR_NAME equals a distinctive string)
  3. Switch to your website folder
  4. docker run -v $(pwd)/:/var/www/html/public/content -v $(pwd)/.config/:/var/www/html/config -p 8080:443 YOUR_NAME/mdblog (where $(pwd) equals the path of your website folder)
  5. You can access your MarkdownBlog via https://localhost:8080/

Note: This setup is only suited for testing purposes. You Should definitely replace the self signed certificate that is generated in the docker container with a real SSL Cert.

  • Your public key ("domain.pem") and the intermediate Certificates ("intermediate.pem") have to be linked into /etc/ssl/certs.
  • Your private key ("domain.key") has to be linked into etc/ssl/private

Furthermore you might want to add custom CA authorities ("ca-bundle.crt") into the /etc/apache2/ssl.crt folder and export the logs /var/log/httpd.

Build with

Tested on

  • Google Chrome 45.x
  • Safari on iOS 8
  • Google Chrome for iOS 45.x
  • Google Chrome for Android 45.x
  • Mozilla Firefox for Ubuntu 31.0

Releases

  • 22.09.2014 v0.1 - initial release
  • 03.10.2015 v0.2 - stable release

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 59.1%
  • JavaScript 33.4%
  • CSS 6.8%
  • Other 0.7%