Fix all markdown linter issues

This commit is contained in:
Niels van Velzen 2022-09-06 22:03:52 +02:00 committed by Max Rumpf
parent de10e5efc8
commit 21bc19654e
5 changed files with 16 additions and 9 deletions

View File

@ -1,3 +1,4 @@
<!-- markdownlint-disable MD033 no-inline-html -->
<h1 align="center">Jellyfin Kotlin SDK</h1> <h1 align="center">Jellyfin Kotlin SDK</h1>
<h3 align="center">Part of the <a href="https://jellyfin.org/">Jellyfin Project</a></h3> <h3 align="center">Part of the <a href="https://jellyfin.org/">Jellyfin Project</a></h3>

View File

@ -59,11 +59,11 @@ export default defineConfig({
text: 'Migrations', text: 'Migrations',
items: [ items: [
{ {
text: 'Migrate to 1.1', text: 'Migrate to v1.1',
link: '/migration/v1.1', link: '/migration/v1.1',
}, },
{ {
text: 'Migrate to 1.2', text: 'Migrate to v1.2',
link: '/migration/v1.2', link: '/migration/v1.2',
}, },
] ]

View File

@ -10,7 +10,7 @@ platform.
![Latest version on Maven Central](https://img.shields.io/maven-central/v/org.jellyfin.sdk/jellyfin-core.svg) ![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 ```kotlin
implementation("org.jellyfin.sdk:jellyfin-core:$sdkVersion") implementation("org.jellyfin.sdk:jellyfin-core:$sdkVersion")
@ -22,6 +22,7 @@ implementation("org.jellyfin.sdk:jellyfin-core:$sdkVersion")
```groovy ```groovy
implementation "org.jellyfin.sdk:jellyfin-core:$sdkVersion" implementation "org.jellyfin.sdk:jellyfin-core:$sdkVersion"
``` ```
</details> </details>
<details> <details>
@ -34,6 +35,7 @@ implementation("org.jellyfin.sdk:jellyfin-core:$sdkVersion")
<version>$sdkVersion</version> <version>$sdkVersion</version>
</dependency> </dependency>
``` ```
</details> </details>
<details> <details>
@ -56,6 +58,7 @@ An example using Gradle with Kotlin DSL that only allows the `master-SNAPSHOT` v
} }
} }
``` ```
</details> </details>
## Usage ## Usage
@ -156,11 +159,14 @@ val recommended = jellyfin.discovery.getRecommendedServers(candidates, Recommend
### Official Jellyfin clients ### Official Jellyfin clients
- [Jellyfin for Android](https://github.com/jellyfin/jellyfin-android) is the official Android client for phones and tablets. - [Jellyfin for Android](https://github.com/jellyfin/jellyfin-android) is the official Android client for phones and
- [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. 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 ### 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!_ _Want to add your project? We'd love to know about it, open an issue or create pull request!_

View File

@ -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 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 function is not recommended being used directly. Use the other functions instead. The function receives a listener

View File

@ -14,7 +14,7 @@ jellyfin-platform-android module was merged into jellyfin-core.
The table below shows the new names to be used: The table below shows the new names to be used:
| Module (before) | Module (after) | | Module (before) | Module (after) |
| ----------------------------- | ----------------- | |-------------------------------|-------------------|
| jellyfin-core | jellyfin-core | | jellyfin-core | jellyfin-core |
| **jellyfin-platform-android** | **jellyfin-core** | | **jellyfin-platform-android** | **jellyfin-core** |
| jellyfin-api | jellyfin-api | | 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. 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 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 a `KtorClient` instance and you might have used this type in your code. Starting from v1.1 it is strongly advised to