Skip to content
This repository

openFrameworks web site

branch: master

Merge pull request #269 from admsyn/patch-1

Fix minor #include typo in shader tutorial
latest commit 0af233b27a
Jason Van Cleave jvcleave authored April 17, 2014
Octocat-spinner-32 _controllers Added handling for function-only classes November 15, 2013
Octocat-spinner-32 _dbtools changed a ton of files to make docs/ into ducmentation/. changed the … December 22, 2011
Octocat-spinner-32 _documentation updated docs to 0.8.1 April 03, 2014
Octocat-spinner-32 _filters Removed unused code server-side code formatting. September 14, 2013
Octocat-spinner-32 _templates Added inline comments to finctions March 15, 2014
Octocat-spinner-32 _tools updated docs to 0.8.1 April 03, 2014
Octocat-spinner-32 _tutorials Fix minor #include typo in shader tutorial April 17, 2014
Octocat-spinner-32 about adding matt miller to contributors list April 15, 2014
Octocat-spinner-32 community barcelona workshops nov. 2013 October 23, 2013
Octocat-spinner-32 css fix for twitter colomn October 14, 2013
Octocat-spinner-32 development mako templates: add encoding headers so special characters don't brea… October 17, 2013
Octocat-spinner-32 download Update older.html.mako March 31, 2014
Octocat-spinner-32 doxygen fix refresh_doxygen April 03, 2014
Octocat-spinner-32 gallery mako templates: add encoding headers so special characters don't brea… October 17, 2013
Octocat-spinner-32 images logo as svg. Closes #255 December 02, 2013
Octocat-spinner-32 js js: fix forum block formmating December 02, 2013
Octocat-spinner-32 setup Update index.html.mako April 16, 2014
Octocat-spinner-32 .gitattributes trying to keep line endings as lf September 14, 2013
Octocat-spinner-32 .gitignore ignore binary asciidoc generated file August 09, 2013
Octocat-spinner-32 _config.py Removed references to the auto-generated communty page. September 16, 2013
Octocat-spinner-32 _version.py Update _version.py March 30, 2014
Octocat-spinner-32 favicon.gif favicon December 26, 2011
Octocat-spinner-32 favicon.ico favicon updated to forum version December 26, 2011
Octocat-spinner-32 index.html.mako remove inst-int banner December 02, 2013
Octocat-spinner-32 readme.md Update links to point to the tutorial October 16, 2013
Octocat-spinner-32 refresh_doxygen.sh fix refresh_doxygen April 03, 2014
readme.md

openFrameworks site

This repository stores the content and code that generates the openFrameworks website.

Setting up the site to build locally

To contribute, fork the repository and download to your local machine. You'll need to install Python, lxml and blogofile 0.8b1:

easy_install lxml
easy_install blogofile

To generate and view the site locally, you have to run:

blogofile build
blogofile serve

And access the local site in http://localhost:8080/

You can start editing pages right away. In order to see your changes on your local version you'll have always have to run build & serve before.

Installing on OS X:

There's a thorough description of the installation procedure on OS X in the Contributing to the Documentation tutorial.

Installing on Debian:

You can install it by downloading the package from the project's page. Then inside the blogofile folder run (as root)

python setup.py install

Your may also need to install asciidoc

Installing on Vanilla Ubuntu 12.04:

aptitude install build-essential gcc python-dev libxslt1-dev git python-setuptools python-pip 
easy_install lxml

git clone https://github.com/EnigmaCurry/blogofile
cd blogofile
python setup.py install

cd ..
git clone https://github.com/openframeworks/ofSite.git
blogofile build
blogofile serve

Documentation-style markdown

The documentation portion of the site is written in Markdown, a wiki-style syntax. See details on Daringfireball.

The easiest way to check the syntax is having a look at the many pages already on the site, but here are some useful tips:

To insert code snippets use four tildes followed by curly braces with ".cpp" inside, and ending with four tildes:

~~~~{.cpp}
for(int i = 0; i < 16; i++) {
    ofLog() << i;
}
~~~~

Images are added using normal markdown format:

![Image Title](filename.png "alt text")

For a more complete description of how to contribute documentation, please see the Contributing to the Documentation tutorial.

Useful Markdown Editors

An alternative to running blogofile locally is to use a Markdown editor that can show you a rendering as you work.

Note: The website utilizes some additions to Markdown itself, so specialized functions such as code syntax highlighting may not be available in the editor, even though it will work fine on the site.

Something went wrong with that request. Please try again.