diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts index d289823..b80435d 100644 --- a/docs/.vuepress/config.ts +++ b/docs/.vuepress/config.ts @@ -9,27 +9,154 @@ export default defineUserConfig({ editLink: false, navbar: [ { text: "Home", link: "/" }, - { text: "Docs", link: "/docs/getting-started.html" } + { text: "Guides", link: "/guides/getting-started.html" }, + { text: "References", link: "/references/ytmusic-methods/getSearchSuggestions.html" } ], sidebar: [ { - text: "Documentation", + text: "Guides", + collapsible: true, children: [ { text: "Getting Started", - link: "/docs/getting-started.html" + link: "/guides/getting-started.html" }, { text: "Usage", - link: "/docs/usage.html" + link: "/guides/usage.html", + children: [ + { + text: "Getting search suggestions", + link: "/guides/usage/getSearchSuggestions.html" + }, + { + text: "Searching for results", + link: "/guides/usage/search.html" + }, + { + text: "Searching for songs", + link: "/guides/usage/searchSong.html" + }, + { + text: "Searching for videos", + link: "/guides/usage/searchVideo.html" + }, + { + text: "Searching for artists", + link: "/guides/usage/searchArtist.html" + }, + { + text: "Searching for albums", + link: "/guides/usage/searchAlbum.html" + }, + { + text: "Searching for playlists", + link: "/guides/usage/searchPlaylist.html" + }, + { + text: "Getting a song", + link: "/guides/usage/getSong.html" + }, + { + text: "Getting a video", + link: "/guides/usage/getVideo.html" + }, + { + text: "Getting an artist", + link: "/guides/usage/getArtist.html" + }, + { + text: "Getting an artist's top songs", + link: "/guides/usage/getArtistSongs.html" + }, + { + text: "Getting an artist's top albums", + link: "/guides/usage/getArtistAlbums.html" + }, + { + text: "Getting an album", + link: "/guides/usage/getAlbum.html" + }, + { + text: "Getting a playlist", + link: "/guides/usage/getPlaylist.html" + }, + { + text: "Getting a playlist's videos", + link: "/guides/usage/getPlaylistVideos.html" + } + ] + } + ] + }, + { + text: "References", + collapsible: true, + children: [ + { + text: "Interfaces", + children: [ + { + text: "ThumbnailFull", + link: "/references/interfaces/ThumbnailFull.html" + }, + { + text: "SongDetailed", + link: "/references/interfaces/SongDetailed.html" + }, + { + text: "SongFull", + link: "/references/interfaces/SongFull.html" + }, + { + text: "VideoDetailed", + link: "/references/interfaces/VideoDetailed.html" + }, + { + text: "VideoFull", + link: "/references/interfaces/VideoFull.html" + }, + { + text: "ArtistBasic", + link: "/references/interfaces/ArtistBasic.html" + }, + { + text: "ArtistDetailed", + link: "/references/interfaces/ArtistDetailed.html" + }, + { + text: "ArtistFull", + link: "/references/interfaces/ArtistFull.html" + }, + { + text: "AlbumBasic", + link: "/references/interfaces/AlbumBasic.html" + }, + { + text: "AlbumDetailed", + link: "/references/interfaces/AlbumDetailed.html" + }, + { + text: "AlbumFull", + link: "/references/interfaces/AlbumFull.html" + }, + { + text: "PlaylistFull", + link: "/references/interfaces/PlaylistFull.html" + } + ] }, { - text: "References", - link: "/docs/references.html" + text: "Types", + children: [ + { + text: "SearchResult", + link: "/references/types/SearchResult.html" + } + ] } ] } - ], - sidebarDepth: 5 + ] } }) diff --git a/docs/README.md b/docs/README.md index e5808bd..29150bd 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ home: true actions: - text: Get Started - link: /docs/getting-started.html + link: /guides/getting-started.html type: primary - text: NPM Registry link: https://npmjs.org/package/ytmusic-api diff --git a/docs/docs/getting-started.md b/docs/guides/getting-started.md similarity index 100% rename from docs/docs/getting-started.md rename to docs/guides/getting-started.md diff --git a/docs/docs/usage.md b/docs/guides/usage.md similarity index 100% rename from docs/docs/usage.md rename to docs/guides/usage.md diff --git a/docs/docs/references.md b/docs/references/references.md similarity index 100% rename from docs/docs/references.md rename to docs/references/references.md