From 21bc19654eb13d5772e55567111b780232eb2504 Mon Sep 17 00:00:00 2001 From: Niels van Velzen Date: Tue, 6 Sep 2022 22:03:52 +0200 Subject: [PATCH] Fix all markdown linter issues --- README.md | 1 + docs/.vitepress/config.ts | 4 ++-- docs/guide/getting-started.md | 14 ++++++++++---- docs/guide/websockets.md | 2 +- docs/migration/v1.1.md | 4 ++-- 5 files changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ba593265..925febc5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +

Jellyfin Kotlin SDK

Part of the Jellyfin Project

diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 09b0bcf8..a7c3de5b 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -59,11 +59,11 @@ export default defineConfig({ text: 'Migrations', items: [ { - text: 'Migrate to 1.1', + text: 'Migrate to v1.1', link: '/migration/v1.1', }, { - text: 'Migrate to 1.2', + text: 'Migrate to v1.2', link: '/migration/v1.2', }, ] diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md index 9fbc483f..5e6c919d 100644 --- a/docs/guide/getting-started.md +++ b/docs/guide/getting-started.md @@ -10,7 +10,7 @@ platform. ![Latest version on Maven Central](https://img.shields.io/maven-central/v/org.jellyfin.sdk/jellyfin-core.svg) -**Gradle with Kotlin DSL** +### Gradle with Kotlin DSL ```kotlin implementation("org.jellyfin.sdk:jellyfin-core:$sdkVersion") @@ -22,6 +22,7 @@ implementation("org.jellyfin.sdk:jellyfin-core:$sdkVersion") ```groovy implementation "org.jellyfin.sdk:jellyfin-core:$sdkVersion" ``` +
@@ -34,6 +35,7 @@ implementation("org.jellyfin.sdk:jellyfin-core:$sdkVersion") $sdkVersion ``` +
@@ -56,6 +58,7 @@ An example using Gradle with Kotlin DSL that only allows the `master-SNAPSHOT` v } } ``` +
## Usage @@ -156,11 +159,14 @@ val recommended = jellyfin.discovery.getRecommendedServers(candidates, Recommend ### Official Jellyfin clients -- [Jellyfin for Android](https://github.com/jellyfin/jellyfin-android) is the official Android client for phones and tablets. -- [Jellyfin for Android TV](https://github.com/jellyfin/jellyfin-androidtv) is the official Android TV client for Android TV, Nvidia Shield, Amazon Fire TV and Google TV. +- [Jellyfin for Android](https://github.com/jellyfin/jellyfin-android) is the official Android client for phones and + tablets. +- [Jellyfin for Android TV](https://github.com/jellyfin/jellyfin-androidtv) is the official Android TV client for + Android TV, Nvidia Shield, Amazon Fire TV and Google TV. ### Third party clients -- [Findroid](https://github.com/jarnedemeulemeester/findroid) provides a native user interface to browse and play movies and series. +- [Findroid](https://github.com/jarnedemeulemeester/findroid) provides a native user interface to browse and play movies + and series. _Want to add your project? We'd love to know about it, open an issue or create pull request!_ diff --git a/docs/guide/websockets.md b/docs/guide/websockets.md index cb27caf9..53c31544 100644 --- a/docs/guide/websockets.md +++ b/docs/guide/websockets.md @@ -94,7 +94,7 @@ instance.addSyncPlayCommandsListener( } ``` -# Advanced listeners +## Advanced listeners All previously mentioned functions to add listeners use the `addListenerDefinition` function under the hood. This function is not recommended being used directly. Use the other functions instead. The function receives a listener diff --git a/docs/migration/v1.1.md b/docs/migration/v1.1.md index 5ce43976..f98a0556 100644 --- a/docs/migration/v1.1.md +++ b/docs/migration/v1.1.md @@ -14,7 +14,7 @@ jellyfin-platform-android module was merged into jellyfin-core. The table below shows the new names to be used: | Module (before) | Module (after) | -| ----------------------------- | ----------------- | +|-------------------------------|-------------------| | jellyfin-core | jellyfin-core | | **jellyfin-platform-android** | **jellyfin-core** | | jellyfin-api | jellyfin-api | @@ -118,7 +118,7 @@ a part of the algorithm was rewritten to report issues. If you're using this fun The system information response was slow. -## Replacing KtorClient +## Replacing KtorClient This version of the SDK changed how the backend of the API part works. Previously the `createApi` function would return a `KtorClient` instance and you might have used this type in your code. Starting from v1.1 it is strongly advised to