このリポジトリは、openFrameworksのWebサイトのコンテンツと、サイトを生成するコードを保持しています。
Webページやドキュメントの修正に協力するには、このリポジトリをforkして、githubのシステムから直接送信してください。
ほとんどのコンテンツは、 content フォルダ内にMarkdown形式で入っています。
第１階層にある tutorials フォルダは、tutorialsカテゴリーを代表しています。tutorialsフォルダ内には.markdownという拡張子のMarkdownファイルが中に入っていて、それぞれのファイルと同じ名前のフォルダに画像などのリソースが格納されています。チュートリアルの最終的なHTMLファイルは、リソースと同じ階層に生成されます。ですので、リンクにはフォルダなどの相対パスは必要ありません。例えば以下のようになります。
documentationフォルダは、oF APIのリファレンスがMarkdown形式で格納されています。これらのドキュメントは、コードから自動生成されます。しかし、それぞれのクラスのdescription フィールドの関数や変数の記述に関しては、Markdownファイルを直接編集することができます。
このサイトは、nikolaを使用しています。先頭の階層に、nikolaを簡単にインストールして使用することが可能ないくつかのスクリプトが用意してあります。
- ./install.sh は、nikolaをインストールして必要な依存関係を構築します。現状ではLinuxとOS Xでしかテストしていません。OS Xでこれらのスクリプトを使用するには、まず初めに下記のパッケージをインストールする必要があります。
brew install python3
sudo easy_install pip
brew linkapps python3そして、下記の内容を、.bashrc 、もしくは .zhsrc ファイルに書き加えます。
export XML_CATALOG_FILES="/usr/local/etc/xml/catalog"
-
./auto_build.sh はnikolaを起動して、毎回更新したファイルのみをwebにビルドします。もしOS Xを利用していて、
FileNotFoundError: [Errno 2] No such file or directory: 'asciidoctor'というエラーになった場合は、asciidoctorをインストールする必要があります。ここの解説を参考にしてください。インストール後、スクリプトを再度実行します。 -
./serve.sh は、サイトを表示するためのローカルにwebサーバーを起動し、ブラウザで表示します。
もし翻訳のような大量の更新を予定しているなら、最後の2つのスクリプトを起動したままにしてコンテントを編集します。サイトは自動的にリフレッシュされるでしょう。
サイトのドキュメントパートは、wiki-styleの文法のMarkdownで記述されます。詳しくは Daringfireball を参照してください。
文法を確認する簡単な方法は、既にサイトにあるページを参照することです。ただし、いくつかのTipsがあります。
コードスニペットを挿入するには、以下のように ".cpp" の記述を明示します。
```cpp
for(int i = 0; i < 16; i++) {
ofLog() << i;
}
```
画像は通常のMarkdownのフォーマットを使用します。
どのようにドキュメンテイションに貢献するかのより詳細な説明は、 Contributing to the Documentation のチュートリアルを参照してください。