Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
openFrameworks web site
Mako Python Other
branch: master
Failed to load latest commit information.
_controllers Added handling for function-only classes
_dbtools changed a ton of files to make docs/ into ducmentation/. changed the …
_documentation Update ofFile.markdown
_filters Removed unused code server-side code formatting.
_templates Update documentation.mako
_tools updated docs to 0.8.1
_tutorials linked perlin noise to wikipedia
about forgot ../ in link
community removing survey links
css css: magenta hr
development initial change from section leaders to teams, and a few updates
download download: fix nightlies frame height
doxygen fix refresh_doxygen
gallery format changes
images update logo
js change home and gallery style
setup removed confusing hint, Raspbian is based on the hardfloat version of…
.gitattributes trying to keep line endings as lf
.gitignore ignore binary asciidoc generated file
_config.py Removed references to the auto-generated communty page.
_version.py 0.8.4
build.sh build scripts
commit_hook.php build scripts
favicon.gif favicon
favicon.ico favicon updated to forum version
index.html.mako removing survey links
readme.md Update links to point to the tutorial
refresh_doxygen.sh fix refresh_doxygen

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.