Migrated to using vuepress@2.0.0-beta

This commit is contained in:
Zechariah Tan 2022-03-29 15:40:37 +08:00
parent 7be05d30d8
commit 76312f8eb4
8 changed files with 1019 additions and 7548 deletions

4
.gitignore vendored
View File

@ -3,4 +3,6 @@
**/dist **/dist
**/config.json **/config.json
**/*.test.ts **/*.test.ts
**/.vscode **/.vscode
**/.temp
**/.cache

1
.npmrc Normal file
View File

@ -0,0 +1 @@
shamefully-hoist=true

View File

@ -1,27 +1,28 @@
import { defineConfig } from "vuepress/config" import { defineUserConfig } from "vuepress"
import type { DefaultThemeOptions } from "vuepress"
export default defineConfig({ export default defineUserConfig<DefaultThemeOptions>({
title: "YTMusic API", title: "YTMusic API",
description: "Unofficial YouTube Music API for TypeScript", description: "Unofficial YouTube Music API for TypeScript",
themeConfig: { themeConfig: {
repo: "zS1L3NT/ts-npm-ytmusic-api", repo: "zS1L3NT/ts-npm-ytmusic-api",
searchPlaceholder: "Search", editLink: false,
smoothScroll: true, navbar: [
//@ts-ignore
displayAllHeaders: true,
activeHeaderLinks: true,
nav: [
{ text: "Home", link: "/" }, { text: "Home", link: "/" },
{ text: "Docs", link: "/docs/getting-started.html" } { text: "Docs", link: "/docs/getting-started.html" }
], ],
sidebar: [ sidebar: [
{ {
title: "Documentation", text: "Documentation",
collapsable: false,
sidebarDepth: 2,
children: [ children: [
["/docs/getting-started", "Getting Started"], {
["/docs/references", "References"] text: "Getting Started",
link: "/docs/getting-started.html"
},
{
text: "References",
link: "/docs/references.html"
}
] ]
} }
] ]

View File

@ -0,0 +1,3 @@
:root {
scroll-behavior: smooth;
}

View File

@ -1,7 +1,9 @@
--- ---
home: true home: true
actionText: Get Started actions:
actionLink: /docs/getting-started.html - text: Get Started
link: /docs/getting-started.html
type: primary
features: features:
- title: YouTube Music Scraper - title: YouTube Music Scraper
details: YTMusic API scrapes https://music.youtube.com for results and formats it for you details: YTMusic API scrapes https://music.youtube.com for results and formats it for you

View File

@ -6,25 +6,29 @@ YTMusic API is an npm package that scrapes data from YouTube Music and formats i
## Installation ## Installation
<code-group> <CodeGroup>
<code-block title="npm"> <CodeGroupItem title="npm" active="true">
```bash
```bash:no-line-numbers
npm i ytmusic-api npm i ytmusic-api
``` ```
</code-block>
<code-block title="yarn"> </CodeGroupItem>
```bash <CodeGroupItem title="yarn">
```bash:no-line-numbers
yarn add ytmusic-api yarn add ytmusic-api
``` ```
</code-block>
<code-block title="pnpm"> </CodeGroupItem>
```bash <CodeGroupItem title="pnpm">
```bash:no-line-numbers
pnpm i ytmusic-api pnpm i ytmusic-api
``` ```
</code-block>
</code-group> </CodeGroupItem>
</CodeGroup>
## Usage ## Usage

View File

@ -29,7 +29,7 @@
"ts-mocha": "^9.0.2", "ts-mocha": "^9.0.2",
"typescript": "^4.5.5", "typescript": "^4.5.5",
"validate-any": "1.3.1", "validate-any": "1.3.1",
"vuepress": "^1.9.7" "vuepress": "^2.0.0-beta.36"
}, },
"keywords": [ "keywords": [
"youtube", "youtube",

File diff suppressed because it is too large Load Diff