Skip to content

Commit a431205

Browse files
committed
Initial commit
0 parents  commit a431205

File tree

16 files changed

+2984
-0
lines changed

16 files changed

+2984
-0
lines changed

.eslintignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules/
2+
!/.vitepress

.eslintrc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"root": true,
3+
"env": {
4+
"browser": true,
5+
"node": true
6+
},
7+
"extends": [
8+
"@techassi"
9+
]
10+
}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

.vitepress/config.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import { defineConfig } from 'vitepress';
2+
3+
import sidebar from './sidebar';
4+
import nav from './nav';
5+
6+
export default defineConfig({
7+
lang: 'en-US',
8+
title: 'VueYoutube',
9+
description: 'Integrate the YouTube Iframe Player into your Vue 2/3 app.',
10+
srcDir: './src',
11+
themeConfig: {
12+
nav,
13+
sidebar,
14+
editLinks: true,
15+
repo: 'vue-youtube/docs',
16+
},
17+
});

.vitepress/nav.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import type { DefaultTheme } from 'vitepress';
2+
3+
const nav: DefaultTheme.Config['nav'] = [
4+
{
5+
text: 'Introduction',
6+
link: '/introduction/overview',
7+
activeMatch: '^/introduction/',
8+
},
9+
{
10+
text: 'Usage',
11+
link: '/usage/composable',
12+
activeMatch: '^/usage/',
13+
},
14+
];
15+
16+
export default nav;

.vitepress/sidebar.ts

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
import type { DefaultTheme } from 'vitepress';
2+
3+
const sidebar: DefaultTheme.Config['sidebar'] = {
4+
'/': [
5+
{
6+
text: 'Introduction',
7+
children: [
8+
{
9+
text: 'What is VueYoutube?',
10+
link: '/introduction/overview',
11+
},
12+
{
13+
text: 'Getting Started',
14+
link: '/introduction/getting-started',
15+
},
16+
],
17+
},
18+
{
19+
text: 'Usage',
20+
children: [
21+
{
22+
text: 'Composable',
23+
link: '/usage/composable',
24+
},
25+
{
26+
text: 'Component',
27+
link: '/usage/component',
28+
},
29+
],
30+
},
31+
],
32+
};
33+
34+
export default sidebar;

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022-PRESENT Techassi <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

env.d.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/* eslint-disable unicorn/prevent-abbreviations */
2+
/// <reference types="vitepress/client" />
3+
/// <reference types="vue/macros-global" />
4+
5+
declare module '@vue/theme/config' {
6+
import type { UserConfig } from 'vitepress';
7+
8+
const config: () => Promise<UserConfig>;
9+
export default config;
10+
}

package.json

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
{
2+
"name": "docs",
3+
"version": "0.0.1",
4+
"description": "Documentation for VueYoutube",
5+
"scripts": {
6+
"preinstall": "npx only-allow pnpm",
7+
"lint": "eslint --ext .js,.vue,.ts .",
8+
"serve": "vitepress serve",
9+
"build": "vitepress build",
10+
"dev": "vitepress dev"
11+
},
12+
"repository": {
13+
"type": "git",
14+
"url": "git+https://github.com/vue-youtube/docs.git"
15+
},
16+
"keywords": [
17+
"vue",
18+
"youtube",
19+
"typescript",
20+
"vue2",
21+
"vue3",
22+
"youtube-iframe-api"
23+
],
24+
"author": "Techassi <[email protected]>",
25+
"license": "MIT",
26+
"bugs": {
27+
"url": "https://github.com/vue-youtube/docs/issues"
28+
},
29+
"homepage": "https://github.com/vue-youtube/docs#readme",
30+
"dependencies": {
31+
"@techassi/eslint-config": "^0.0.9",
32+
"eslint": "^8.9.0",
33+
"typescript": "^4.5.5",
34+
"vitepress": "^0.22.2",
35+
"vue": "^3.2.31"
36+
}
37+
}

0 commit comments

Comments
 (0)