Skip to content

Commit

Permalink
docs(plugin): add search doc
Browse files Browse the repository at this point in the history
  • Loading branch information
QingWei-Li committed Feb 19, 2017
1 parent 2351c3e commit 5153317
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
10 changes: 8 additions & 2 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,13 @@ By default, the hyperlink on the current page is recognized and the content is s
search: {
maxAge: 86400000, // Expiration time, the default one day
paths: [], // or 'auto'
placeholder: 'Type to search'
placeholder: 'Type to search',
// Localization
placeholder: {
'/zh-cn/': '搜索',
'/': 'Type to search'
}
}
}
</script>
Expand Down Expand Up @@ -101,7 +107,7 @@ window.$docsify = {
}
```

!> You can get internal methods through `window.Docsify.utils`.
!> You can get internal methods through `window.Docsify`. Get the current instance through the second argument.

#### Example

Expand Down
10 changes: 8 additions & 2 deletions docs/zh-cn/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,13 @@
search: {
maxAge: 86400000, // 过期时间,单位毫秒,默认一天
paths: [], // or 'auto'
placeholder: 'Type to search'
placeholder: 'Type to search',
// 支持本地化
placeholder: {
'/zh-cn/': '搜索',
'/': 'Type to search'
}
}
}
</script>
Expand Down Expand Up @@ -96,7 +102,7 @@ window.$docsify = {
}
```

!> 如果需要用 docsify 的内部方法,可以通过 `window.Docsify.utils` 获取。
!> 如果需要用 docsify 的内部方法,可以通过 `window.Docsify` 获取,通过 `vm` 获取当前实例

#### 例子

Expand Down

0 comments on commit 5153317

Please sign in to comment.