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
**/config.json
**/*.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",
description: "Unofficial YouTube Music API for TypeScript",
themeConfig: {
repo: "zS1L3NT/ts-npm-ytmusic-api",
searchPlaceholder: "Search",
smoothScroll: true,
//@ts-ignore
displayAllHeaders: true,
activeHeaderLinks: true,
nav: [
editLink: false,
navbar: [
{ text: "Home", link: "/" },
{ text: "Docs", link: "/docs/getting-started.html" }
],
sidebar: [
{
title: "Documentation",
collapsable: false,
sidebarDepth: 2,
text: "Documentation",
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
actionText: Get Started
actionLink: /docs/getting-started.html
actions:
- text: Get Started
link: /docs/getting-started.html
type: primary
features:
- title: YouTube Music Scraper
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
<code-group>
<code-block title="npm">
```bash
<CodeGroup>
<CodeGroupItem title="npm" active="true">
```bash:no-line-numbers
npm i ytmusic-api
```
</code-block>
<code-block title="yarn">
```bash
</CodeGroupItem>
<CodeGroupItem title="yarn">
```bash:no-line-numbers
yarn add ytmusic-api
```
</code-block>
<code-block title="pnpm">
```bash
</CodeGroupItem>
<CodeGroupItem title="pnpm">
```bash:no-line-numbers
pnpm i ytmusic-api
```
</code-block>
</code-group>
</CodeGroupItem>
</CodeGroup>
## Usage

View File

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

File diff suppressed because it is too large Load Diff