PHDoc

PHDoc is the neat piece of software with which I maintain this site. It generates static HTML files, which is good for you because:

• static files are blazingly fast to serve
• you can use any web server
• with extremely simple configuration
• the files never break
• and there are no security issues

PHDoc handles uploading the files to the server for you. It also comes with an embedded web server, so you can preview your site directly on your computer.

Cool Features

• Set up Google Analytics tracking in one line of configuration.

• Barebones wikis that just look like directories with Markdown-formatted text files in them.

• A built-in HTTP server and WSGI application to serve up a compiled wiki with a single command.

• Continuous builds (via rsync) mean the server can keep running whilst Markdoc re-compiles the wiki. Just refresh your browser to see the changes.

• Add Pygments-powered syntax highlighting to your Markdoc wiki with a single configuration parameter.

Quickstart

Setting up PHDoc takes mere seconds on Linux and Mac systems. It can also be done on Windows, if you have a Python installation.

Installation

$ easy_install phdoc  # OR
$ pip install phdoc

Making a Wiki

phdoc init my-wiki
cd my-wiki/
vim wiki/somefile.md
# ... write some documents ...
phdoc build
phdoc serve
# .. open http://localhost:8008/ in a browser ...