Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(readme): broken links #2

Merged
merged 1 commit into from
Jun 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[example]: https://github.com/manriif/supabase-edge-functions-kt-example
[website]: https://manriif.github.io/supabase-edge-functions-kt

# Supabase Edge Functions Kotlin

Expand All @@ -10,7 +11,7 @@ as primary programming language.
[![](https://img.shields.io/badge/Stability-experimental-orange)](#project-stability)
[![Kotlin](https://img.shields.io/badge/kotlin-2.0.0-blue.svg?logo=kotlin)](http://kotlinlang.org)
[![IR](https://img.shields.io/badge/Kotlin%2FJS-IR_only-yellow)](https://kotl.in/jsirsupported)
[![API](https://img.shields.io/badge/API-dokka-green)]()
[![API](https://img.shields.io/badge/API-dokka-green)][website]
[![Maven Central](https://img.shields.io/maven-central/v/io.github.manriif.supabase-functions/github-plugin?label=MavenCentral&logo=apache-maven)](https://search.maven.org/artifact/org.jetbrains.dokka/io.github.manriif.supabase-functions)
[![Gradle Plugin](https://img.shields.io/gradle-plugin-portal/v/io.github.manriif.supabase-functions?label=Gradle&logo=gradle)](https://plugins.gradle.org/plugin/io.github.manriif.supabase-functions)
[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
Expand Down Expand Up @@ -102,9 +103,9 @@ suspend fun serve(request: Request): Response {
After a successful gradle sync and if you are using an IntelliJ based IDE, you will see new run configurations for your function.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/manriif/supabase-edge-functions-kt/dev/docs/run_config_dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/manriif/supabase-edge-functions-kt/dev/docs/run_config_light.png">
<img alt="Run configurations" src="https://raw.githubusercontent.com/manriif/supabase-edge-functions-kt/dev/docs/run_config_light.png">
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/manriif/supabase-edge-functions-kt/main/readme/run_config_dark.png">
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/manriif/supabase-edge-functions-kt/main/readme/run_config_light.png">
<img alt="Run configurations" src="https://raw.githubusercontent.com/manriif/supabase-edge-functions-kt/main/readme/run_config_light.png">
</picture>

Run:
Expand Down
15 changes: 9 additions & 6 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
* Use of this source code is governed by the MIT license.
*/

import org.jetbrains.dokka.gradle.AbstractDokkaTask
import org.jetbrains.dokka.gradle.DokkaMultiModuleTask

plugins {
Expand All @@ -17,6 +18,14 @@ allprojects {
group = property("project.group").toString()
version = rootProject.libs.versions.supabase.functions.get()
extra["isModule"] = path.startsWith(":modules")

val dokkaBase = """{
"footerMessage": "© 2024 <a href=\"https://github.com/manriif\">Maanrifa Bacar Ali</a>."
}"""

tasks.withType<AbstractDokkaTask>().configureEach {
pluginsMapConfiguration = mapOf("org.jetbrains.dokka.base.DokkaBase" to dokkaBase)
}
}

tasks.withType<DokkaMultiModuleTask> {
Expand All @@ -25,10 +34,4 @@ tasks.withType<DokkaMultiModuleTask> {
includes = dokkaDir.files("README.md")
moduleName = rootProject.property("project.name").toString()
outputDirectory = dokkaDir.dir("documentation")

pluginsMapConfiguration = mapOf(
"org.jetbrains.dokka.base.DokkaBase" to """{
"footerMessage": "© 2024 <a href=\"https://github.com/manriif\">Maanrifa Bacar Ali</a>."
}"""
)
}