Skip to content

Commit

Permalink
Updated docs (zh-TW)
Browse files Browse the repository at this point in the history
  • Loading branch information
tommy351 committed Mar 1, 2013
1 parent 4bca24a commit afe8538
Show file tree
Hide file tree
Showing 9 changed files with 213 additions and 218 deletions.
21 changes: 2 additions & 19 deletions source/zh-TW/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,44 +11,31 @@ date: 2012-11-01 18:13:30

建立網站,若`folder`未定義,則Hexo會在目前的資料夾建立網站

hexo init <folder>
hexo init [folder]

建立新文章

hexo new [layout] <title>

生成靜態檔案,使用`-t``--theme`以忽略主題安裝

- -t/--theme:忽略主題安裝
- -d/--deploy:生成後自動佈署
- -w/--watch:監視檔案變更

```
hexo generate
hexo generate -t/--theme
hexo generate -d/--deploy
hexo generate -w/--watch
```

啟動伺服器,按下`Ctrl+C`停止伺服器

- -p/--port:連接埠設定
- -s/--static:僅處理靜態檔案

```
hexo server
hexo server -p 12345
```

預覽,按下`Ctrl+C`停止伺服器

- -p/--port:連接埠設定
- -w/--watch:監視檔案變更

```
hexo preview
hexo preview -p 12345
```

顯示網站設定

hexo config
Expand All @@ -64,10 +51,6 @@ hexo deploy --setup
hexo deploy --generate
```

渲染檔案

hexo render <source> <destination>

安全模式,此模式下外掛不會被載入

hexo --safe
Expand Down
141 changes: 76 additions & 65 deletions source/zh-TW/docs/collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,107 +5,118 @@ lang: zh-TW
date: 2012-11-01 18:13:30
---

<a id="collection"></a>
## Collection
自 1.0 版後,Hexo 採用 [Warehouse][1] 記錄所有資料,[Warehouse][1] 繼承了舊有的部份程式碼,並增加了搜尋功能,效能提昇,更為強大。

Collection 類別用於一般的文章集合。
[1]: https://github.com/tommy351/warehouse

<a name="model>"></a>
## Model

Model 為資料的集合。

#### get(id1[, id2, ..., idN])

取得指定編號的資料。當 `id` 數量大於 1 時返回陣列。

#### each(iterator)

執行迴圈`iterator(item, i)``item`為迴圈目前的項目,`i`為迴圈執行的次數(從0開始)。

**別名**:forEach

#### map(iterator)
遞迴 Model 內所有項目,執行 `iterator(data, id)``data` 為資料,`id` 為編號。

執行迴圈`iterator(item, i)`,並用其回傳值代替原項目的值,`item`為迴圈目前的項目,`i`為迴圈執行的次數(從0開始)。
#### toArray()

#### filter(iterator)
將 Model 轉換為陣列。

執行迴圈`iterator(item, i)`,若其回傳值為真,則保留其值,`item`為迴圈目前的項目,`i`為迴圈執行的次數(從0開始)。
#### count()

**別名**:select

#### toArray
返回 Model 的元素數量,相等於 `length`

將物件轉換為陣列(Array)。
#### insert(data, callback)

#### slice(start, [end])
插入資料至 Model。`data` 可為物件(Object)或陣列(Array),插入完成後,執行回呼函數 `callback(data, id)``data` 為資料,`id` 為編號。

取出物件中的特定部分。`start`, `end`的值可為負數。
#### update([id, ]data)

#### skip(num)
更新資料。`id` 可為數字、陣列,當不指定時會更新 Model 內的所有資料。

忽略物件中最前的指定段落。
操作元:

#### limit(num)
- **$push** - 對陣列插入元素
- **$pull** - 從陣列移除元素
- **$shift** - 刪除陣列前幾個元素
- **$pop** - 刪除陣列後幾個元素
- **$addToSet** - 對陣列插入元素(不重複)
- **$inc** - 增加數字
- **$dec** - 減少數字

限制傳回的物件數量。
#### replace([id, ]data)

#### set(item)
取代資料。`id` 可為數字、陣列,當不指定時會取代 Model 內的所有資料。

在物件中新增項目。
#### remove([id1, id2, ..., idN])

**別名**:push

#### sort(orderby, [order])
移除資料。不指定 `id` 時會刪除 Model 內的所有資料。

排列物件。`order``1`, `asc`時為升冪排列(預設),`-1`, `desc`時為降冪排列。
#### destroy()

#### reverse
從資料庫刪除 Model 的所有資料。

反轉物件順序。
#### first()

#### random
取得第一個物件。

隨機排列物件。
#### last()

**別名**:shuffle
取得最後一個物件。

<a id="taxonomy"></a>
## Taxonomy
#### eq(num)

Taxonomy 類別用於文章分類集合,是 Collection 類別的繼承,與 Collection 類別的差別在於 Taxonomy 類別使用字串當作鍵值
取得指定位置的資料

#### get(name)
#### slice(start[, end])

取得物件中的指定項目。

#### set(name, item)
取得特定區段的資料。`start``end` 可為負數。

在物件中新增一個名為`name`的項目。
#### limit(num)

**別名**:push

#### each(iterator)
限制物件數量。

#### skip(num)

省略前幾個物件。

#### reverse()

反轉物件順序。

#### sort(orderby[, order])

排序物件。`order``-1``desc` 時為降冪排列,預設為升冪排列。

#### random()

執行迴圈`iterator(value, key, i)``value`為迴圈目前的項目數值,`key`為迴圈目前的項目名稱,`i`為迴圈執行的次數(從0開始)。

**別名**:forEach

#### map(iterator)
隨機排序 Model 內的資料。

執行迴圈`iterator(value, key, i)`,並用其回傳值代替原項目的值,`value`為迴圈目前的項目數值,`key`為迴圈目前的項目名稱,`i`為迴圈執行的次數(從0開始)。
#### find(query)

#### filter(iterator)
尋找資料。

執行迴圈`iterator(value, key, i)`,若其回傳值為真,則保留其值,`value`為迴圈目前的項目數值,`key`為迴圈目前的項目名稱,`i`為迴圈執行的次數(從0開始)。
操作元:

**別名**:select
- **$lt** - 小於
- **$lte** - 小於或等於
- **$gt** - 大於
- **$gte** - 大於或等於
- **$length** - 陣列長度
- **$in** - 陣列內含有指定元素
- **$nin** - 陣列內不含有指定元素
- **$all** - 陣列內含有所有指定元素
- **$exists** - 物件存在
- **$ne** - 不等於

<a id="paginator"></a>
## Paginator
#### findRaw(query)

Paginator 類別是原類別的繼承,僅增加下列屬性
根據原始內容,尋找資料

- **per_page** - 每頁顯示的文章數量
- **total** - 文章總數量
- **current** - 目前頁數
- **current_url** - 目前頁數的網址
- **posts** - [Collection 類別][1]
- **prev** - 上一頁的頁數
- **prev_link** - 上一頁的連結
- **next** - 下一頁的頁數
- **next_link** - 下一頁的連結
#### findOne(query)

[1]: #collection
尋找資料,並只返回第一個物件。
14 changes: 11 additions & 3 deletions source/zh-TW/docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,15 @@ hexo.emit('event', [arg1], [arg2], [….]);

### generateAfter

生成檔案完成後。
檔案生成完成後。

### processBefore

開始處理原始檔案前。

### processAfter

原始檔案處理完畢後。

### new

Expand All @@ -47,9 +55,9 @@ hexo.emit('event', [arg1], [arg2], [….]);

伺服器開啟後。

### preview
### exit

預覽伺服器開啟後
程式結束時

[1]: global-variables.html
[2]: http://nodejs.org/api/events.html#events_class_events_eventemitter
46 changes: 24 additions & 22 deletions source/zh-TW/docs/global-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ Hexo 在初始化時,會建立一個名為`hexo`的命名空間(Namespace)
- **[util](#util)** - 工具程式
- **[i18n](#i18n)** - 國際化(i18n)模組
- **[route](#route)** - 路由模組
- **[cache](#cache)** - 快取模組
- **[call](#call)** - 呼叫其他 Console
- **[db](#db)** - 資料庫

<a id="extend"></a>
<a name="extend"></a>
### extend

extend是負責處理所有擴充套件的模組,每個物件都有兩種方法:**list****register**,前者可列出該物件所掌管的所有擴充套件,後者可掛載新的擴充套件到該物件上。
Expand Down Expand Up @@ -56,7 +57,7 @@ extend是負責處理所有擴充套件的模組,每個物件都有兩種方
#### processor

- **list** - 返回一個陣列(Array)
- **register(fn)** - 掛載擴充套件
- **register(rule, fn)** - 掛載擴充套件`rule`為路徑規則,可為字串(String)或正規表示式(RegExp)。

#### helper

Expand All @@ -75,7 +76,7 @@ extend是負責處理所有擴充套件的模組,每個物件都有兩種方

更多資訊請參考 [外掛開發][2]

<a id="util"></a>
<a name="util"></a>
### util

util為工具程式,包含下列模組:
Expand Down Expand Up @@ -109,13 +110,13 @@ util為工具程式,包含下列模組:

用以解析 [YAML Front Matter][3],輸出一個物件(Object),本文存放於`_content`屬性。

<a id="i18n"></a>
<a name="i18n"></a>
### i18n

i18n為處理國際化(Internationalization)的模組,使用方式如下:

``` js
var i18n = new hexo.i18n();
var i18n = new hexo.i18n.i18n();
```

i18n物件擁有以下方法:
Expand Down Expand Up @@ -147,11 +148,9 @@ i18n物件擁有以下方法:

自動載入語言檔案。`path`為放置語言檔案的資料夾,Hexo會根據`_config.yml``language`設定載入相對應的語言檔案,若找不到語言檔案的話,則會載入`default.yml`,因此資料夾內至少要有一個`default.yml`

<a id="route"></a>
<a name="route"></a>
### route

自從0.3版之後,Hexo開始引入路由模組處理網站的所有檔案路徑。

#### get(path)

取得路徑內容,傳回一個函數。
Expand All @@ -164,32 +163,35 @@ i18n物件擁有以下方法:

處理路徑格式。若路徑為空或結尾為`/`,則在最後加入`index.html`

#### destroy(path)
#### remove(path)

刪除路徑。

#### list()

返回一個物件(Object)。

<a id="cache"></a>
### cache

#### list()
<a name="call"></a>
### call

列出所有快取內容。
#### call(name, [args], callback)

#### get(name)
- **name** - Console 外掛名稱
- **args** - 參數
- **callback** - 回傳函數

取得指定快取。
call 是用於呼叫其他 Console 外掛的函數,例如:

#### set(name, value, [callback])

設定快取內容。
``` js
hexo.call('generate', function(){
// ...
});
```

#### destroy(name, [callback])
<a name="db"></a>
### db

刪除指定快取
資料庫

[1]: configure.html
[2]: plugin-development.html
Expand Down
Loading

0 comments on commit afe8538

Please sign in to comment.