Write up your projects and resources in Markdown, host and view locally
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bootstrap
.localized
LICENSE.txt
README.md
_footer.html
_header-2.html
_header.html
fixes.css
index.html
markdown.php
org.html
preview.png

README.md

org

Summary

Write up your projects and resources in Markdown, host and view locally on a Mac (with Apache/PHP).

Screenshot preview of the system

Setup

  • As of OSX 10.8, they've removed the 'web sharing' ability, so I downloaded this to bring it back. (OSX keeps apache and php in, so you just need to enable the web sharing).

  • Modify some config file settings to get it to work (/etc/apache2/httpd.conf and /etc/php.ini).

  • Don't make the PHP error reporting any stricter, because it's annoying as hell and unnecessary.

  • Change the document root in TWO PLACES to something like /Users/<uname> (/etc/apache2/httpd.conf).

  • Allow PHP in HTML pages (/etc/apache2/httpd.conf).

That should be it. You might have to do a bit of fiddling with the paths in Sites/ or org/ if they've changed, but you should be good to go. Until next catastrophe.

Configure

You'll want to edit the following variables in org.html (this should be configured in another way, but there's no reason to bother unless someone else ever uses this).

  • $orgDir : This should point to your main directory that contains projects and someday directories.
  • $idxFilename : This is what it will look for as the 'index' for each project.

How you should place files

It assumes under your $orgDir you have two directories, projects and someday. It then assumes that you have one folder per project (project folders go in either of these directories). Then, it expects you have a file of the name $idxFilename, which it will parse/render as Markdown. At the bottom of each index file, it will generate a 'resources' section with links to all other files that you put in that project directory.

Future work

I don't like being stuck in PHP, and the Markdown parsing isn't going anywhere (I want code highlighting!), so I'll likely rewrite this into a Node project in the near future. Then it will be cross-platform, too!

Thanks to