Skip to content

Commit 2855d5d

Browse files
committed
updated docs
1 parent 42f3f70 commit 2855d5d

File tree

2 files changed

+56
-33
lines changed

2 files changed

+56
-33
lines changed

docs/.vuepress/config.js

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
const { description } = require("../../package");
2-
const WindiCSS = require("vite-plugin-windicss").default;
3-
const { resolve } = require("path");
1+
const { description } = require('../../package')
2+
const WindiCSS = require('vite-plugin-windicss').default
3+
const { resolve } = require('path')
44

55
module.exports = {
66
// dev server port
77
port: 8082,
88

99
// site config
10-
lang: "en-US",
11-
title: "Vue Number Format",
10+
lang: 'en-US',
11+
title: 'Vue Number Format',
1212
description: description,
1313
head: [
14-
["meta", { name: "theme-color", content: "#3eaf7c" }],
15-
["meta", { name: "apple-mobile-web-app-capable", content: "yes" }],
14+
['meta', { name: 'theme-color', content: '#3eaf7c' }],
15+
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
1616
[
17-
"meta",
18-
{ name: "apple-mobile-web-app-status-bar-style", content: "black" },
17+
'meta',
18+
{ name: 'apple-mobile-web-app-status-bar-style', content: 'black' },
1919
],
2020
[
21-
"meta",
21+
'meta',
2222
{
23-
name: "google-site-verification",
24-
content: "Tf6UVeu-ZmZtGqB5tdcYymZ79101gyGKcpzqwWhDb1U",
23+
name: 'google-site-verification',
24+
content: 'Tf6UVeu-ZmZtGqB5tdcYymZ79101gyGKcpzqwWhDb1U',
2525
},
2626
],
2727
],
@@ -33,39 +33,39 @@ module.exports = {
3333
WindiCSS({
3434
preflight: false,
3535
scan: {
36-
include: [resolve(__dirname, "./**/*.{vue,html,md}")],
37-
exclude: ["node_modules/**/*", ".git/**/*"],
36+
include: [resolve(__dirname, './**/*.{vue,html,md}')],
37+
exclude: ['node_modules/**/*', '.git/**/*'],
3838
},
3939
theme: {
4040
extend: {
4141
colors: {
42-
primary: "#3eaf7c",
42+
primary: '#3eaf7c',
4343
},
4444
},
4545
},
46-
plugins: [require("windicss/plugin/forms")],
46+
plugins: [require('windicss/plugin/forms')],
4747
}),
4848
],
4949
},
5050
},
5151

5252
// theme and its config
53-
theme: "@vuepress/theme-default",
53+
theme: '@vuepress/theme-default',
5454
themeConfig: {
55-
logo: "/favicon.png",
55+
logo: '/favicon.png',
5656
editLinks: false,
57-
repo: "coders-tm/vue-number-format",
57+
repo: 'coders-tm/vue-number-format',
5858
lastUpdated: true,
5959
sidebar: {
60-
"/guide/": [
60+
'/guide/': [
6161
{
62-
title: "Guide",
62+
title: 'Guide',
6363
collapsable: false,
6464
children: [
65-
"/guide/README.md",
66-
"/guide/config.md",
67-
"/guide/example.md",
68-
"/guide/play-ground.md",
65+
'/guide/README.md',
66+
'/guide/config.md',
67+
'/guide/demo.md',
68+
'/guide/play-ground.md',
6969
],
7070
},
7171
],
@@ -74,26 +74,26 @@ module.exports = {
7474
darkMode: false,
7575
plugins: [
7676
[
77-
"@vuepress/plugin-search",
77+
'@vuepress/plugin-search',
7878
{
7979
locales: {
80-
"/": {
81-
placeholder: "Search",
80+
'/': {
81+
placeholder: 'Search',
8282
},
8383
},
8484
},
8585
],
8686
[
87-
"@vuepress/register-components",
87+
'@vuepress/register-components',
8888
{
89-
componentsDir: resolve(__dirname, "./components"),
89+
componentsDir: resolve(__dirname, './components'),
9090
},
9191
],
9292
[
93-
"@vuepress/plugin-google-analytics",
93+
'@vuepress/plugin-google-analytics',
9494
{
95-
id: "UA-76508942-4",
95+
id: 'UA-76508942-4',
9696
},
9797
],
9898
],
99-
};
99+
}

docs/guide/demo.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Example
2+
3+
### Vue3 Component
4+
5+
<p>
6+
<iframe src="https://codesandbox.io/embed/vue-number-format-vue3-example-67dczb?fontsize=14&hidenavigation=1&theme=dark"
7+
style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;"
8+
title="Vue Number Format Vue3 Example"
9+
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
10+
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
11+
></iframe>
12+
</p>
13+
14+
### Integration with Quasar
15+
16+
<p>
17+
<iframe src="https://codesandbox.io/embed/vue-number-format-integration-with-quasar-nxqb77?fontsize=14&hidenavigation=1&theme=dark"
18+
style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;"
19+
title="Vue Number Format: Integration with Quasar"
20+
allow="accelerometer; ambient-light-sensor; camera; encrypted-media; geolocation; gyroscope; hid; microphone; midi; payment; usb; vr; xr-spatial-tracking"
21+
sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
22+
></iframe>
23+
</p>

0 commit comments

Comments
 (0)