这个仓库是openFrameworks网站的源代码和内容源文件。
支持的语言有:
- 英文(English) : readme.md
- 日本语(日本語) : readme.ja.md
- 韩国语(韩国語) : readme.ko.md
修改网站内容原文件时需要先fork到你的github里面,然后在你的github里面将修改的内容通过pull request提交。
大部分内容保存在 content
目录里面。
tutorials
目录是教程源文件目录的主目录,里面包含着很多子目录,每一个子目录是包含着一个教程系列的教程源文件,每一个教程源文件的格式是 .markdown
。 目录结构是:
/tutorials/教程系列名字/教程.markdown
每个教程原文件与引用的图片在相同的路径里面,所以写图片路径时要写相对路径。
示例:
![img](image.png)
documentation
目录里面是所有oF API的参考信息。API信息原文件是用代码生成的,但是里面的 description
字段是可以直接用markdown语法编写。
这个网站是基于 nikola环境生成的. 为了方便搭建环境已经为大家准备好了环境搭建脚本。
-
./install.sh 是安装
nikola
和必要的依赖包。现在支持的环境是Linux和Mac OS X。在Mac 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
编译生成网站。在 Mac OS X 出现FileNotFoundError: [Errno 2] No such file or directory: 'asciidoctor'
错误时, 按照这里教程步骤安装asciidoctor
后在运行脚本。 -
./serve.sh 会在本地运行网站服务器,这样就可以在浏览器访问本地地址查看网站效果.
修改文档源文件或翻译文档时先运行 ./auto_build.sh
后再运行 ./serve.sh
两个同时运行。这时有任何文件变化时网站会自动更新。
网站一部分文档是使用markdown
语法。Markdown
语法是 wiki-style
.
具体语法请参考: Daringfireball。
可以查看网站的其他网页理解语法。 附上几个例子:
插入代码时后面加上cpp
:
```cpp
for(int i = 0; i < 16; i ) {
ofLog() << i;
}
```
插入图片时使用Markdown
语法:
![Image Title](filename.png "alt text")
关于贡献文档具体事项请参考, 贡献文档教程。