Skip to content
openFrameworks web site
Mako Python Other
Find file
New pull request
Latest commit 56081a6 @arturoc arturoc Merge pull request #333 from tpltnt/deprecate-ofRect
Deprecate ofRect()
Failed to load latest commit information.
_controllers Fixes errors when parsing inlined docs + inheritance
_dbtools changed a ton of files to make docs/ into ducmentation/. changed the …
_documentation synced with master, resolved merge conflicts
_filters Removed unused code server-side code formatting.
_templates fix index links
_tools remove hardcoded paths from clang_utils
_tutorials synced with master, resolved merge conflicts
about old suggestion from @caitlinmorris
community use minified jquery.cycle on cdn
css more style fixes
development development: remove CI now it's integrated with github
download point RPI2 to general RPI guide
doxygen fix refresh_doxygen
gallery format changes
icons added function/class icons + fixed some style issues
images update logo
js docs: style fixes for index blocks
setup Minor update
.gitattributes trying to keep line endings as lf
.gitignore ignore binary asciidoc generated file 0.9.0 0.9.0 build scripts
commit_hook.php build scripts
favicon.gif favicon
favicon.ico favicon updated to forum version
index.html.mako bigger template and font sizes inserted space after markdown heading indicator fix refresh_doxygen add module docs intro template + clang scripts

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 blogofile from the Debian (Jessie) repositories by running

sudo sudo apt-get install -y blogofile python-lxml

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

python 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
cd blogofile
python install

cd ..
git clone
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:

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.