Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
royalfig committed May 29, 2024
1 parent 0ddd398 commit 99cf555
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 28 deletions.
4 changes: 2 additions & 2 deletions docs/.vitepress/cache/deps/@royalfig_share-button.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/.vitepress/cache/deps/@royalfig_share-button.js.map

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/.vitepress/cache/deps/_metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@
"vue": {
"src": "../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
"file": "vue.js",
"fileHash": "e5124be0",
"fileHash": "62ce1fc5",
"needsInterop": false
},
"vitepress > @vue/devtools-api": {
"src": "../../../node_modules/@vue/devtools-api/dist/index.js",
"file": "vitepress___@vue_devtools-api.js",
"fileHash": "8532cc50",
"fileHash": "2e0aa744",
"needsInterop": false
},
"vitepress > @vueuse/core": {
"src": "../../../node_modules/@vueuse/core/index.mjs",
"file": "vitepress___@vueuse_core.js",
"fileHash": "9bb290f8",
"fileHash": "78dce1ab",
"needsInterop": false
},
"vitepress > @vueuse/integrations/useFocusTrap": {
"src": "../../../node_modules/@vueuse/integrations/useFocusTrap.mjs",
"file": "vitepress___@vueuse_integrations_useFocusTrap.js",
"fileHash": "536f754f",
"fileHash": "d5bf3ae8",
"needsInterop": false
},
"vitepress > mark.js/src/vanilla.js": {
Expand All @@ -43,7 +43,7 @@
"@theme/index": {
"src": "../../../node_modules/vitepress/dist/client/theme-default/index.js",
"file": "@theme_index.js",
"fileHash": "97946048",
"fileHash": "35da2138",
"needsInterop": false
},
"@royalfig/share-button": {
Expand Down
28 changes: 14 additions & 14 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@

import { defineConfig } from "vitepress";
// import vue from '@vitejs/plugin-vue'
import vue from '@vitejs/plugin-vue'
// https://vitepress.dev/reference/site-config
export default defineConfig({
// vite: {
// plugins: [
// vue({
// template: {
// compilerOptions: {
// // treat all tags with a dash as custom elements
// isCustomElement: (tag) => tag.includes('-')
// }
// }
// })
// ]
// },
vue: {
template: {
compilerOptions: {
// treat all tags with a dash as custom elements
isCustomElement: (tag) => tag.includes('-')
}
}
},


title: "Share Button ",
description: "A custom web component for seamless sharing",
head: [
Expand All @@ -29,7 +28,7 @@ export default defineConfig({
border: 1px solid var(--vp-c-divider);
border-radius: 8px;
}`,
],
]
],
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
Expand Down Expand Up @@ -62,6 +61,7 @@ export default defineConfig({
{ text: "Color", link: "/examples/color" },
{ text: "Text", link: "/examples/text" },
{ text: "Networks", link: "/examples/networks" },
{ text: "Icons only", link: "/examples/atomic" },
],
},
],
Expand Down
6 changes: 5 additions & 1 deletion docs/examples/atomic.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,8 @@ To enable individual buttons, use the `atomic` attribute.

<div class="sb-container">
<share-button atomic></share-button>
</div>
</div>

<script>
import "@royalfig/share-button"
</script>
4 changes: 2 additions & 2 deletions docs/examples/color.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ title: Color
</div>

<script>
import "@royalfig/share-button"
</script>
import "@royalfig/share-button"
</script>
6 changes: 5 additions & 1 deletion docs/examples/networks.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,8 @@ To customize networks and their order, use the `networks` attribute and pass in

::: tip Hey there!
Don't see a network you want to use? File a GitHub issue to get it added!
:::
:::

<script>
import "@royalfig/share-button"
</script>
6 changes: 5 additions & 1 deletion docs/examples/text.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,8 @@ To omit text altogether, use the `circle` attribute. The button will render with

::: tip Icon
Use the [`icon`](/examples/icon.md) attribute to change the icon.
:::
:::

<script>
import "@royalfig/share-button"
</script>
1 change: 0 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,3 @@ features:
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
---

<share-button></share-button>

0 comments on commit 99cf555

Please sign in to comment.