MDR is a markdown document reader and navigator system designed for lightweight docs that can be easily hosted on GitHub for community contributions, that also allows custom HTML and templating for total control of your own wiki-like site.
By offloading editing to GitHub, you site can run blazingly fast with just a few files, and a couple of lines of Markdown. In fact, almost half the projects size is Parsedown, a better Markdown processor, without the need to offer registration, editing, or any of that messy stuff like password resets that comes with it (if you're looking to have that handled, try Simplet).
- The latest stable version of Nginx.
- A supported release of PHP.
- Some Markdown files to replace the examples.
- Copy all the files into your web folder.
- Edit
_mdr/nginx.conf. You only need to changeserver_name,root, anderror_log. - Use that conf file to configure Nginx. You can do this with the command
sudo ln -s /var/www/com.example/_mdr/nginx.conf /etc/nginx/sites-enabled/com.example - Take a look at the settings at the top of
_mdr/index.php. You can change any of the settings in that file and the site will update as soon as you save it.
| Library | Version | Language |
|---|---|---|
| Parsedown | 1.5.1 | PHP |
| ParsedownExtra | 0.7.0 | PHP |
| Normalize.css | Automatic (from JSDelivr) | CSS |
| Colors.css | Automatic (from JSDelivr) | CSS |
| elementary Web Styles | January 2015 (sans Fonts) | CSS |
| Droid Serif | Automatic (from Google Fonts) | Font |
| Open Sans | Automatic (from Google Fonts) | Font |
| Inconsolata | Automatic (from Google Fonts) | Font |
| REM Polyfill | Automatic (from JSDelivr) | JavaScript |