diff --git a/.vscode/settings.json b/.vscode/settings.json index 56af8e14..851f13bf 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -2,4 +2,7 @@ "editor.detectIndentation": false, "editor.insertSpaces": true, "editor.tabSize": 2, + "files.associations": { + "*.md": "mdx" + }, } diff --git a/SpotifyAPI.Docs/docs/auth_introduction.md b/SpotifyAPI.Docs/docs/auth_introduction.md index c2233a9d..4652d7f4 100644 --- a/SpotifyAPI.Docs/docs/auth_introduction.md +++ b/SpotifyAPI.Docs/docs/auth_introduction.md @@ -3,6 +3,8 @@ id: auth_introduction title: Introduction --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + Spotify does not allow unauthorized access to the api. Thus, you need an access token to make requets. This access token can be gathered via multiple schemes, all following the OAuth2 spec. Since it's important to choose the correct scheme for your usecase, make sure you have a grasp of the following terminology/docs: * OAuth2 @@ -17,4 +19,4 @@ Then, continue with the docs of the specific auth flows: * [Authorization Code](authorization_code.md) * [Token Swap](token_swap.md) -![auth comparison](/img/auth_comparison.png) +auth comparison diff --git a/SpotifyAPI.Docs/docs/example_asp.md b/SpotifyAPI.Docs/docs/example_asp.md index adc6c85e..783ec73b 100644 --- a/SpotifyAPI.Docs/docs/example_asp.md +++ b/SpotifyAPI.Docs/docs/example_asp.md @@ -3,6 +3,8 @@ id: example_asp title: ASP.NET --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + ## Description This example is based on ASP .NET Core. It uses `Authorization Code` under the hood with the help of [`AspNet.Security.OAuth.Spotify`](https://www.nuget.org/packages/AspNet.Security.OAuth.Spotify/). It stores the access token in the current user session (cookie-based) and allows to refresh tokens when they expire. Two pages are implemented: @@ -10,8 +12,8 @@ This example is based on ASP .NET Core. It uses `Authorization Code` under the h * Home shows your current playlists via pagination * Profile shows your current profile information -![ASP Example - Home](/img/asp_example_home.png) -![ASP Example - Profile](/img/asp_example_profile.png) +ASP Example - Home +ASP Example - Profile ## Run it diff --git a/SpotifyAPI.Docs/docs/example_blazor.md b/SpotifyAPI.Docs/docs/example_blazor.md index 4b09256e..13d5550c 100644 --- a/SpotifyAPI.Docs/docs/example_blazor.md +++ b/SpotifyAPI.Docs/docs/example_blazor.md @@ -3,11 +3,13 @@ id: example_blazor title: Blazor ServerSide --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + ## Description Very similar to the [Blazor WASM Example](example_blazor_wasm.md), but runs code on the server side and pushes view updates to the client. -![ASP Blazor Example - Home](/img/asp_blazor_example_home.png) +ASP Blazor Example - Home ## Run it diff --git a/SpotifyAPI.Docs/docs/example_blazor_wasm.md b/SpotifyAPI.Docs/docs/example_blazor_wasm.md index d8679676..e30b0508 100644 --- a/SpotifyAPI.Docs/docs/example_blazor_wasm.md +++ b/SpotifyAPI.Docs/docs/example_blazor_wasm.md @@ -3,15 +3,16 @@ id: example_blazor_wasm title: Blazor WASM --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + ## Description This small cross-platform web app runs on `Blazor WebAssembly`, which was released on 19. May 2020. It allows to run C# code in any browser which supports WebAssembly. This allows to create .NET full-stack web projects without writing any JavaScript. Find more about [Blazor WebAssembly here](https://devblogs.microsoft.com/aspnet/blazor-webassembly-3-2-0-now-available/) Since this library is compatible with `.NET Standard 2.1`, you can use all features of `SpotifyAPI.Web` in your blazor wasm app. The example logs the user in via `Implicit Grant` and does 2 user-related API requests from the browser. You can observe the requests from your browsers network tools. -![BlazorWASM Spotify Example](/img/blazorwasm_homepage.png) - -![BlazorWASM Spotify Example - network tools](/img/blazorwasm_network_tools.png) +BlazorWASM Spotify Example +BlazorWASM Spotify Example - network tools ## Run it diff --git a/SpotifyAPI.Docs/docs/implicit_grant.md b/SpotifyAPI.Docs/docs/implicit_grant.md index 411c7e12..850d991f 100644 --- a/SpotifyAPI.Docs/docs/implicit_grant.md +++ b/SpotifyAPI.Docs/docs/implicit_grant.md @@ -3,6 +3,8 @@ id: implicit_grant title: Implicit Grant --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + > Implicit grant flow is for clients that are implemented entirely using JavaScript and running in the resource owner’s browser. You do not need any server-side code to use it. Rate limits for requests are improved but there is no refresh token provided. This flow is described in RFC-6749. This flow is useful for getting a user access token for a short timespan @@ -35,7 +37,7 @@ Note, this parameter is not sent to the server! You need JavaScript to access it This flow can also be used with custom protocols instead of `http`/`https`. This is especially interesting for `UWP` apps, since your able to register custom protocol handlers quite easily. -![protocol handlers](/img/auth_protocol_handlers.png) +protocol handlers The process is very similar, you generate a uri and open it for the user diff --git a/SpotifyAPI.Docs/docs/proxy.md b/SpotifyAPI.Docs/docs/proxy.md index 5e59d174..6da107e4 100644 --- a/SpotifyAPI.Docs/docs/proxy.md +++ b/SpotifyAPI.Docs/docs/proxy.md @@ -3,6 +3,8 @@ id: proxy title: Proxy --- +import useBaseUrl from '@docusaurus/useBaseUrl'; + The included `HTTPClient` has full proxy configuration support: ```csharp @@ -21,5 +23,4 @@ var spotify = new SpotifyClient(config); As an example, [mitmproxy](https://mitmproxy.org/) can be used to inspect the requests and responses: -![mitmproxy](/img/mitmproxy.png) - +mitmproxy