Skip to content

Latest commit

 

History

History
 
 

config

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

why need config

Cocos website exists:

  1. English: http://www.cocos2d-x.org/
  2. 中文:https://www.cocos.com/

the gitbook be published twice, links are different on both. So add the config to adapt this.

how to change

Config of the master branch will be for cocos.com, if you need to change config to cocos2d-x.org, only need run:

cd to docs root dir
> cp -rf config/cocos2d-x.org/ ./

What has been changed?

  1. 添加了手册文档, Api 文档的版本切换功能。
    (Add a new feature to switch the version of tutorial docs and Api docs.)
  2. 修改了 css 样式,用于新功能的动态布局。
    (Modify the css code in order to dynamic adaptation.)
  3. en 文件夹下的 book.json 增加新数组记录新版本链接和名称。
    (Add a new array in book.json which exist in en(zh) fold, the array is used to record the new doc version link and name.)
  4. page.html 和 header.html 模板修改,增加关于切换版本的内容。
    (Modify the template html files, increase a part of code to relate to the new feature.)

How to change your official website content?

  1. 实际上大部分的内容已经上传到主仓库:https://github.com/cocos-creator/creator-docs
    你需要将最新的提交 pull 到本地。在根目录(./creator-docs/..)下的 en/zh 文件夹中找到 config 文件夹下 en/zh 文件夹内对应的各个文件。将 config 中旧的文件替换为最新的文件。
    之后 请记得将中文网站的官网链接替换为英文网站的链接 执行 cp 命令将旧的文件进行覆盖。

  2. 由于我们修改了部分模板以及 gitbook 的插件,所以请记使用 config 文件夹下的 book.json 文件替换 creator-docs 文件夹下的 book.json 文件,之后在构建文档之前请记得执行:

    gitbook install
    

    更新你的插件内容。当完成以上操作你就可进行构建你的文档了。

  3. 接下来需要你关注的是 另一个 book.json 这个文件,它 存在于 en / zh 文件夹 下,查看内容你会发现如下图 1-1 所示: 1-1

    上图中有三个版本的手册内容,分别包含 名称 以及 链接 参数。每当你发布一个新的版本手册时,都需要将对应的手册名称,链接添加到这个 book.json 中。 请记住: 链接(link)的对应格式 :

    // this is the creator docs format
    official_path/version_number/manual/language
    
    // this is the creator api docs format
    official_path/version_number/api/language
    

    因为不同版本间文档并不是公用一套 book.json 内容(这意味着多份 book.json 文件),所以在这里提醒一下,一旦修改了一个版本文档的 book.json, 其他版本文档下的 book.json 文件一样需要修改。

  4. 创建你自己的版本内容,每一个版本的手册都需要你创建一个对应的本地文件库(不同版本间的文档内容是相互独立的)方便管理,在不同的版本手册仓库下执行 gitbook install 安装插件,之后执行 gitbook 的构建命令生成对应的 _book。

  5. 最后发布,将对应的版本手册库放入自己制定的发布文件夹(这个文件夹的位置决定了你的链接地址)下,请记得将 book.json 中对应的链接修改成为你安放库的路径。