Skip to content

Commit 7e7e5d0

Browse files
committed
✨ Add docsearch plugin from agolia
1 parent 2ab4cac commit 7e7e5d0

File tree

4 files changed

+18
-3
lines changed

4 files changed

+18
-3
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,12 @@ If you're looking for v1 check this [branch](https://github.com/apertureless/vue
3434

3535
Simply run `yarn add vue-chartjs chart.js`
3636

37-
Or if you want to use it directly in the browser add `https://unpkg.com/[email protected]/dist/vue-chartjs.full.min.js` to your scripts. See [Codepen](https://codepen.io/apertureless/pen/vxWbqB?editors=1010)
37+
Or if you want to use it directly in the browser add
38+
39+
```html
40+
<script src="https://unpkg.com/[email protected]/dist/vue-chartjs.full.min.js"></script>
41+
```
42+
to your scripts. See [Codepen](https://codepen.io/apertureless/pen/vxWbqB?editors=1010)
3843

3944
## Explanation of Different Builds
4045
There are three different entry points. It depends on which build setup do you have. The dependencies are bundled or required as a peerDependency.

docs/config.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ docute.init({
3030
]
3131
},
3232
plugins: [
33-
evanyou()
33+
evanyou(),
34+
docsearch({
35+
apiKey: 'b3544f7387612693644777553675d56a',
36+
indexName: 'vue-chartjs',
37+
// algolia docsearch allows you to search with tag filter
38+
tags: ['english', 'de'],
39+
// this plugin does require a url too
40+
// where docsearch fetches contents
41+
url: 'https://vue-chartjs.org'
42+
})
3443
],
3544
})

docs/de/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
search: deutsch
2+
search: de
33
---
44

55
# vue-chartjs

docs/index.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
<div id="app"></div>
1313
<script src="https://unpkg.com/docute-evanyou"></script>
1414
<script src="https://unpkg.com/docute/dist/docute.js"></script>
15+
<script src="https://unpkg.com/docute/plugins/docsearch.js"></script>
1516
<script src="./config.js"></script>
1617
<!-- don't remove this part end -->
1718

0 commit comments

Comments
 (0)