Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saket/unfurl
Generate link previews, inspired by Slack.
https://github.com/saket/unfurl
kotlin preview social
Last synced: 7 days ago
JSON representation
Generate link previews, inspired by Slack.
- Host: GitHub
- URL: https://github.com/saket/unfurl
- Owner: saket
- License: apache-2.0
- Created: 2022-03-16T16:07:55.000Z (over 2 years ago)
- Default Branch: trunk
- Last Pushed: 2024-08-28T15:34:25.000Z (2 months ago)
- Last Synced: 2024-10-14T20:48:11.396Z (25 days ago)
- Topics: kotlin, preview, social
- Language: Kotlin
- Homepage:
- Size: 345 KB
- Stars: 266
- Watchers: 4
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-list - saket/unfurl - Generate link previews, inspired by Slack. (Kotlin)
- awesome - saket/unfurl - Generate link previews, inspired by Slack. (Kotlin)
README
# unfurl
A kotlin library for generating link previews by extracting their [Twitter Card](https://developer.x.com/en/docs/twitter-for-websites/cards/guides/getting-started) and [Open Graph](https://ogp.me/) tags.
```groovy
implementation "me.saket.unfurl:unfurl:2.2.0"
```
```kotlin
val unfurler = Unfurler()
println(unfurler.unfurl("https://saket.me/great-teams-merge-fast/"))
UnfurlResult(
url = "https://saket.me/great-teams-merge-fast",
title = "Great teams merge fast",
description = "Observations from watching my team at Square produce stellar work while moving fast and not breaking things.",
favicon = "https://saket.me/wp-content/uploads/2022/03/cropped-saket-photo-180x180.jpg",
thumbnail = "https://saket.me/wp-content/uploads/2021/02/great_teams_merge_fast_cover.jpg"
)
```
`unfurl` is extensible. See [MastodonUnfurlerExtension](https://github.com/saket/unfurl/blob/0867097e4ac310605b8a789ae20518f9ad3a3f13/cli/src/main/kotlin/me/saket/unfurl/cmd/extensions/MastodonUnfurlerExtension.kt#L16) as an example for unfurling statuses that can't be HTML scraped.
```kotlin
val unfurler = Unfurler(
extensions = listOf(MastodonUnfurlerExtension(), ...)
)
```
### cli
```bash
$ brew install saket/repo/unfurl
$ unfurl https://saket.me/great-teams-merge-fast
```
## License
```
Copyright 2022 Saket Narayan.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```