Git Product home page Git Product logo

org's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.