OpenSesame documentation area

Copyright 2010-2014 Sebastiaan Mathôt s.mathot@cogsci.nl

About

This repository contains the source for http://osdoc.cogsci.nl/.

Format

All files are formatted with Markdown syntax, and are compiled using Kramdown or (for the newer pages) academicmarkdown. Jekyll is used to generate the site structure. For documentation, see the respective homepages of these tools.

The site content is available in the folder content.

Site generation

The compile script generates the sites. This script uses jekyll for the actual site generation, but conducts some additional pre-processing and error checking. To compile the site, run:

./compile

To compile the site and optimize (minify) the HTML files, run:

./compile --optimize-html

For a complete list of options, run:

./compile --help

The site structure is read from sitemap.txt.

Dependencies

Most dependencies are available from the Ubuntu repositories or from the Cogsci.nl PPA. Only htmlcompressor.jar and yui-compressor.jar must be downloaded from their respective websites and manually placed in the osdoc source folder.

jekyll
python-academicmarkdown
kramdown
node-less
linkchecker         # Optional, for checking for dead links
htmlcompressor.jar  # Optional, for compressing HTML
yuicompressor		# Optional, for compressing HTML

License information

OpenSesame documentation area by Sebastiaan Mathôt is licensed under a Creative Commons Attribution 3.0 Unported License.
Based on a work at https://github.com/smathot/osdoc.