Skip to content

jlengrand/OpenGraphKt

Repository files navigation

OpenGraphKt

build Codecov GitHub Release Date Maven Central Version kotlin-version GitHub License GitHub code size in bytes

OpenGraphKt is a minimalist Kotlin multiplatform library to work with the Open Graph tags protocol. OpenGraphKt is a tiny wrapper on top of JSoup.

Current status

  • Library can extract OpenGraph tags from HTML via a URL, String or File input.
  • Protocol implementation is complete for og: tags, but types aren't fully correct (most types currently are String).
  • Library should be considered in pre-alpha, use this in production at your own risks :).

Usage

See Main.kt in the demo-remote submodule for usage examples.

In short :

  • Add dependency to your Maven / Gradle file. For example :
    implementation("fr.lengrand:opengraphkt:0.1.0")
  • Enjoy:
val parser = Parser()
val openGraphDataDoc = parser.parse("https://www.imdb.com/title/tt0068646/")

println("Title: ${openGraphDataDoc.title}")
println("Is valid: ${openGraphDataDoc.isValid()}")

// Title: The Rock
// Is valid: true

Author

License

About

OpenGraphKt is a minimalist Kotlin multiplatform library to work with the Open Graph protocol.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages