Skip to content

Commit f78be4c

Browse files
QingWei-LiQingWei-Li
committed
feat: add navigation plugin, closed #180 
1 parent 2ab0d72 commit f78be4c

File tree

3 files changed

+148
-5
lines changed

3 files changed

+148
-5
lines changed

Diff for: ‎docs/de-de/plugins.md

+67-1
Original file line numberDiff line numberDiff line change
@@ -105,4 +105,70 @@ Exclude the special image
105105

106106
## Edit on github
107107

108-
Add `Edit on github` button on every pages. provided by 3rd party, check [document](https://github.com/njleonzhang/docsify-edit-on-github)
108+
Add `Edit on github` button on every pages. Provided by [@njleonzhang](https://github.com/njleonzhang), check [document](https://github.com/njleonzhang/docsify-edit-on-github)
109+
110+
## Copy to Clipboard
111+
112+
Add a simple `Click to copy` button to all preformatted code blocks to effortlessly allow users to copy example code from your docs. Provided by [@jperasmus](https://github.com/jperasmus)
113+
114+
```html
115+
<link rel="stylesheet" href="//unpkg.com/docsify-copy-code/styles.css">
116+
<script src="//unpkg.com/docsify-copy-code/index.js"></script>
117+
```
118+
119+
```javascript
120+
window.$docsify = {
121+
plugins: [
122+
window.DocsifyCopyCodePlugin.init()
123+
]
124+
}
125+
```
126+
127+
See [here](https://github.com/jperasmus/docsify-copy-code/blob/master/README.md) for more details.
128+
129+
130+
131+
## Disqus
132+
133+
Disqus comments. https://disqus.com/
134+
135+
```html
136+
<script>
137+
window.$docsify = {
138+
disqus: 'shortname'
139+
}
140+
</script>
141+
<script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>
142+
```
143+
144+
145+
## Gitalk
146+
147+
[Gitalk](https://github.com/gitalk/gitalk) is a modern comment component based on Github Issue and Preact.
148+
149+
```html
150+
<link rel="stylesheet" href="//unpkg.com/gitalk/dist/gitalk.css">
151+
152+
<script src="//unpkg.com/docsify/lib/plugins/gitalk.min.js"></script>
153+
<script src="//unpkg.com/gitalk/dist/gitalk.min.js"></script>
154+
<script>
155+
const gitalk = new Gitalk({
156+
clientID: 'Github Application Client ID',
157+
clientSecret: 'Github Application Client Secret',
158+
repo: 'Github repo',
159+
owner: 'Github repo owner',
160+
admin: ['Github repo collaborators, only these guys can initialize github issues'],
161+
// facebook-like distraction free mode
162+
distractionFreeMode: false
163+
})
164+
</script>
165+
```
166+
167+
## Navigation
168+
169+
Pagination for docsify. By [@imyelo](https://github.com/imyelo)
170+
171+
```html
172+
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
173+
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
174+
```

Diff for: ‎docs/plugins.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Exclude the special image
106106

107107
## Edit on github
108108

109-
Add `Edit on github` button on every pages. provided by 3rd party, check [document](https://github.com/njleonzhang/docsify-edit-on-github)
109+
Add `Edit on github` button on every pages. Provided by [@njleonzhang](https://github.com/njleonzhang), check [document](https://github.com/njleonzhang/docsify-edit-on-github)
110110

111111
## Demo code with instant preview and jsfiddle integration
112112

@@ -119,7 +119,7 @@ When readers expand the demo box, the source code and description are shown ther
119119

120120
## Copy to Clipboard
121121

122-
Add a simple `Click to copy` button to all preformatted code blocks to effortlessly allow users to copy example code from your docs.
122+
Add a simple `Click to copy` button to all preformatted code blocks to effortlessly allow users to copy example code from your docs. Provided by [@jperasmus](https://github.com/jperasmus)
123123

124124
```html
125125
<link rel="stylesheet" href="//unpkg.com/docsify-copy-code/styles.css">
@@ -152,7 +152,7 @@ Disqus comments. https://disqus.com/
152152

153153
## Gitalk
154154

155-
Gitalk is a modern comment component based on Github Issue and Preact. https://github.com/gitalk/gitalk
155+
[Gitalk](https://github.com/gitalk/gitalk) is a modern comment component based on Github Issue and Preact.
156156

157157
```html
158158
<link rel="stylesheet" href="//unpkg.com/gitalk/dist/gitalk.css">
@@ -170,4 +170,14 @@ Gitalk is a modern comment component based on Github Issue and Preact. https://g
170170
distractionFreeMode: false
171171
})
172172
</script>
173-
```
173+
```
174+
175+
## Navigation
176+
177+
Pagination for docsify. By [@imyelo](https://github.com/imyelo)
178+
179+
```html
180+
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
181+
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
182+
```
183+

Diff for: ‎docs/zh-cn/plugins.md

+67
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,70 @@ Medium's 风格的图片缩放插件. 基于 [medium-zoom](https://github.com/fr
103103
## 在 Github 上编辑
104104

105105
在每一页上添加 `Edit on github` 按钮. 由第三方库提供, 查看 [document](https://github.com/njleonzhang/docsify-edit-on-github)
106+
107+
108+
## Copy to Clipboard
109+
110+
Add a simple `Click to copy` button to all preformatted code blocks to effortlessly allow users to copy example code from your docs. Provided by [@jperasmus](https://github.com/jperasmus)
111+
112+
```html
113+
<link rel="stylesheet" href="//unpkg.com/docsify-copy-code/styles.css">
114+
<script src="//unpkg.com/docsify-copy-code/index.js"></script>
115+
```
116+
117+
```javascript
118+
window.$docsify = {
119+
plugins: [
120+
window.DocsifyCopyCodePlugin.init()
121+
]
122+
}
123+
```
124+
125+
See [here](https://github.com/jperasmus/docsify-copy-code/blob/master/README.md) for more details.
126+
127+
128+
129+
## Disqus
130+
131+
Disqus comments. https://disqus.com/
132+
133+
```html
134+
<script>
135+
window.$docsify = {
136+
disqus: 'shortname'
137+
}
138+
</script>
139+
<script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>
140+
```
141+
142+
143+
## Gitalk
144+
145+
[Gitalk](https://github.com/gitalk/gitalk) is a modern comment component based on Github Issue and Preact.
146+
147+
```html
148+
<link rel="stylesheet" href="//unpkg.com/gitalk/dist/gitalk.css">
149+
150+
<script src="//unpkg.com/docsify/lib/plugins/gitalk.min.js"></script>
151+
<script src="//unpkg.com/gitalk/dist/gitalk.min.js"></script>
152+
<script>
153+
const gitalk = new Gitalk({
154+
clientID: 'Github Application Client ID',
155+
clientSecret: 'Github Application Client Secret',
156+
repo: 'Github repo',
157+
owner: 'Github repo owner',
158+
admin: ['Github repo collaborators, only these guys can initialize github issues'],
159+
// facebook-like distraction free mode
160+
distractionFreeMode: false
161+
})
162+
</script>
163+
```
164+
165+
## Navigation
166+
167+
Pagination for docsify. By [@imyelo](https://github.com/imyelo)
168+
169+
```html
170+
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
171+
<script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
172+
```

0 commit comments

Comments
 (0)