From 1fd009a8b232a15513625b25ab457b3c45f744a1 Mon Sep 17 00:00:00 2001 From: Zechariah Date: Wed, 30 Mar 2022 22:40:21 +0800 Subject: [PATCH] Added docs for all routes --- docs/.vuepress/config.ts | 5 ++++- docs/references/interfaces.md | 14 ++++++++++++++ docs/references/types.md | 3 +++ docs/references/ytmusic.md | 19 +++++++++++++++++++ 4 files changed, 40 insertions(+), 1 deletion(-) create mode 100644 docs/references/interfaces.md create mode 100644 docs/references/types.md create mode 100644 docs/references/ytmusic.md diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index fa36a58..030ec26 100644 --- a/docs/.vuepress/config.ts +++ b/docs/.vuepress/config.ts @@ -10,7 +10,7 @@ export default defineUserConfig({ navbar: [ { text: "Home", link: "/" }, { text: "Guides", link: "/guides/getting-started.html" }, - { text: "References", link: "/references/ytmusic/getSearchSuggestions.html" } + { text: "References", link: "/references/ytmusic.html" } ], sidebar: [ { @@ -95,6 +95,7 @@ export default defineUserConfig({ children: [ { text: "YTMusic Class", + link: "/references/ytmusic.html", children: [ { text: "getSearchSuggestions", @@ -160,6 +161,7 @@ export default defineUserConfig({ }, { text: "Interfaces", + link: "/references/interfaces.html", children: [ { text: "ThumbnailFull", @@ -213,6 +215,7 @@ export default defineUserConfig({ }, { text: "Types", + link: "/references/types.html", children: [ { text: "SearchResult", diff --git a/docs/references/interfaces.md b/docs/references/interfaces.md new file mode 100644 index 0000000..9451164 --- /dev/null +++ b/docs/references/interfaces.md @@ -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) diff --git a/docs/references/types.md b/docs/references/types.md new file mode 100644 index 0000000..c41ffa1 --- /dev/null +++ b/docs/references/types.md @@ -0,0 +1,3 @@ +# Types + +- [SearchResult](../types/SearchResult.html) diff --git a/docs/references/ytmusic.md b/docs/references/ytmusic.md new file mode 100644 index 0000000..85cc2f2 --- /dev/null +++ b/docs/references/ytmusic.md @@ -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)