2 API說明文件 編輯者閱讀 - imonology/ImonCloud-Doc GitHub Wiki

編輯步驟

1. 最上層 IC 功能列表 新增連結

2. 第二層 IC.XXX API列表 新增連結

連結可先新增。

編輯者，點擊不存在連結，會進入編輯模式

一般讀者，點擊不存在連結，會回到首頁

編輯者注意事項

• 搜尋API

  PAGE 樹狀結構中，搜尋API

  沒有API，請新增 網頁右上角 ， NEW PAGE

• 編輯API說明

  標題打 API 名稱 = IC.xxx.xxx ;

  內容參照API樣板----API 撰寫參考

• 新增API說明連結，方便編輯時，分辨有無資料存在

  1. IC 功能列表 新增連結與說明

     已有資料 => 在連結旁邊 加上說明

     例如：IC.Utility---通用工具

     未有資料 => 在連結旁邊 無說明

     例如：IC.Utility

  2. IC.XXX API列表 新增連結語說明

     已有資料 => 在連結旁邊 加上說明

     例如：createUUID---建立UUID

     未有資料 => 在連結旁邊 無說明

     例如：createUUID

###編輯器功能

• 項目 => [ + 項目 ]

換行 => 需要多一行空白 => 兩次ENTER鍵

標題變大

文字底下加入=>--------------------------------

連結 => [連結文字](連結位置)