Added docs for all routes

This commit is contained in:
Zechariah 2022-03-30 22:40:21 +08:00
parent 9c08ac660e
commit 1fd009a8b2
4 changed files with 40 additions and 1 deletions

View File

@ -10,7 +10,7 @@ export default defineUserConfig<DefaultThemeOptions>({
navbar: [ navbar: [
{ text: "Home", link: "/" }, { text: "Home", link: "/" },
{ text: "Guides", link: "/guides/getting-started.html" }, { text: "Guides", link: "/guides/getting-started.html" },
{ text: "References", link: "/references/ytmusic/getSearchSuggestions.html" } { text: "References", link: "/references/ytmusic.html" }
], ],
sidebar: [ sidebar: [
{ {
@ -95,6 +95,7 @@ export default defineUserConfig<DefaultThemeOptions>({
children: [ children: [
{ {
text: "YTMusic Class", text: "YTMusic Class",
link: "/references/ytmusic.html",
children: [ children: [
{ {
text: "getSearchSuggestions", text: "getSearchSuggestions",
@ -160,6 +161,7 @@ export default defineUserConfig<DefaultThemeOptions>({
}, },
{ {
text: "Interfaces", text: "Interfaces",
link: "/references/interfaces.html",
children: [ children: [
{ {
text: "ThumbnailFull", text: "ThumbnailFull",
@ -213,6 +215,7 @@ export default defineUserConfig<DefaultThemeOptions>({
}, },
{ {
text: "Types", text: "Types",
link: "/references/types.html",
children: [ children: [
{ {
text: "SearchResult", text: "SearchResult",

View File

@ -0,0 +1,14 @@
# Interfaces
- [ThumbnailFull](./interfaces/ThumbnailFull.html)
- [SongDetailed](./interfaces/SongDetailed.html)
- [SongFull](./interfaces/SongFull.html)
- [VideoDetailed](./interfaces/VideoDetailed.html)
- [VideoFull](./interfaces/VideoFull.html)
- [ArtistBasic](./interfaces/ArtistBasic.html)
- [ArtistDetailed](./interfaces/ArtistDetailed.html)
- [ArtistFull](./interfaces/ArtistFull.html)
- [AlbumBasic](./interfaces/AlbumBasic.html)
- [AlbumDetailed](./interfaces/AlbumDetailed.html)
- [AlbumFull](./interfaces/AlbumFull.html)
- [PlaylistFull](./interfaces/PlaylistFull.html)

3
docs/references/types.md Normal file
View File

@ -0,0 +1,3 @@
# Types
- [SearchResult](../types/SearchResult.html)

View File

@ -0,0 +1,19 @@
# YTMusic Class
## Methods
- [getSearchSuggestions](./ytmusic/getSearchSuggestions.html)
- [search](./ytmusic/search.html)
- [searchSongs](./ytmusic/searchSongs.html)
- [searchVideos](./ytmusic/searchVideos.html)
- [searchArtists](./ytmusic/searchArtists.html)
- [searchAlbums](./ytmusic/searchAlbums.html)
- [searchPlaylists](./ytmusic/searchPlaylists.html)
- [getSong](./ytmusic/getSong.html)
- [getVideo](./ytmusic/getVideo.html)
- [getArtist](./ytmusic/getArtist.html)
- [getArtistSongs](./ytmusic/getArtistSongs.html)
- [getArtistAlbums](./ytmusic/getArtistAlbums.html)
- [getAlbum](./ytmusic/getAlbum.html)
- [getPlaylist](./ytmusic/getPlaylist.html)
- [getPlaylistVideos](./ytmusic/getPlaylistVideos.html)