openFrameworks web site
Switch branches/tags
Nothing to show
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_dbtools Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
content android studio guide: fix broken external links Oct 23, 2018
documentation.ko/math Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
documentation readToPixels float said short. Fixes #680 Nov 15, 2018
files donations page May 1, 2018
learning Update page to reflect new oF version and glm support Aug 20, 2018
messages update changelog address Nov 14, 2018
plugins docs: add site_url to index blocks May 9, 2018
themes/openframeworks download: trying to fix changelog link Nov 14, 2018
tutorials Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
utils fix certificate problem Nov 14, 2018
.gitattributes Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
.gitignore ignore vscode May 1, 2018
README-ja.md refact README language Mar 17, 2018
README-ko.md refact README language Mar 17, 2018
README-zh.md refact README language Mar 17, 2018
README.md fix typo Oct 29, 2018
auto_build.sh fix auto build script Mar 16, 2017
book_hook.php Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
build.sh Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
build_docs.sh build_docs.sh: fix checkout + add bash env May 2, 2018
build_server.sh Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
commit_hook.php Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
conf.py 0.10.1 Nov 14, 2018
icons.svg donations page May 1, 2018
import_release.sh import_release: don't import vs2015 not generated anymore Apr 13, 2018
install.sh install: update pip before installing anything May 13, 2018
install_dependencies.sh Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
release_hook.php Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
serve.sh Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016
set_env.sh Revert ""## 참여하기" 쪽 약간의 오타수정및 의역" Nov 15, 2016

README.md

openFrameworks site

English | 中文 | 日本語 | 한국어

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

Contributing

To contribute fixes to the webpage or documentation you can usually just fork this repository and send contributions directly from github.

Most of the content is in the content folder in markdown folder.

The tutorials folder is structured with a first level of folders that represent the category and then a inside them markdown files with the extension .markdown and a folder for each of them with the same name as the text file that contains images or any other resource. The final html for each tutorial gets generated at the same level as it's resources so the links have to be relative and without any folder like:

![img](image.png)

The documentation folder contains the OF API reference and are also in markdown format. This docs are generated from the code but the description field in every class, function or var can be edited directly in the markdown files.

Setting up the site to build locally

This site is built using nikola. There's some scripts in the root folder to make it easier to install and use.

  1. First, if installing on Mac OS-X, make sure the Xcode command lines tools have been installed:
xcode-select --install

and then install the following packages (If you do not have brew installed you can grab it from brew.sh):

brew install python3
sudo easy_install pip
brew linkapps python3
  1. From the ofSite source directory, run ./install.sh which installs nikola and all the needed dependencies. (This has only been tested on linux and OS-X).

  2. Finally add the following to your .basrc, .bash_profile or .zshrc file: export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"

There are two scripts included in the ofSite root to help work with the docs:

./auto_build.sh : Runs nikola and builds the site every time any file is modified.

If, on osx, you receive this error: FileNotFoundError: [Errno 2] No such file or directory: 'asciidoctor', you need to install asciidoctor as explained here, and then run the script again.

./serve.sh : Starts a local web server that serves the site and opens it in the browser.

If you plan to do a big modifications like contribute a translation the easiest is to leave the 2 last scripts running and just edit the content files and the site will automatically get refreshed.

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 three tildes followed by curly braces with ".cpp" inside, and ending with three 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.