Skip to content
openFrameworks web site
Python CSS JavaScript
Pull request Compare This branch is 1350 commits behind openframeworks:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
_controllers
_dbtools
_documentation
_filters
_templates
_tools
_tutorials
about
community
css
development
download
doxygen
gallery
images
js
setup
.gitattributes
.gitignore
_config.py
_version.py
favicon.gif
favicon.ico
index.html.mako
readme.md

readme.md

openFrameworks site

This repository stores the content 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:

easy_install lxml
easy_install blogofile

If you run into trouble, check the notes below.

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.

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")

Additional tips can be found in Contributing Documentation on the ofSite wiki

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.

Notes

The latest version of the ofSite works with Blogofile 0.8b1.

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
Something went wrong with that request. Please try again.