Skip to content

Commit

Permalink
[Glide] Highlight Coil on Glide guide (#423)
Browse files Browse the repository at this point in the history
Coil should be preferred for most applications due to
its usage of Kotlin Coroutines.
  • Loading branch information
chrisbanes authored May 18, 2021
1 parent 9071dc0 commit d42a212
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/coil.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This library provides easy-to-use [Painter][painter] which can fetch and display

<img src="https://coil-kt.github.io/coil/logo.svg" width="480" alt="Coil logo">

!!! info
??? info "Migrating from CoilImage"
If you're migrating from Accompanist 0.7.x or before, please read the [migration](./migration-coilimage) documentation after reading this document.

## `rememberCoilPainter()`
Expand Down
7 changes: 6 additions & 1 deletion docs/glide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,12 @@ This library brings easy-to-use [Painter][painter] which can fetch and display i

<img src="https://github.com/bumptech/glide/blob/master/static/glide_logo.png?raw=true" width="480" alt="Glide logo">

!!! info
!!! tip
Unless you have a specific requirement to use Glide, consider using [Coil](coil.md) instead.
Coil is built upon Kotlin Coroutines which means that it integrates better with
Jetpack Compose, which also heavily uses [Coroutines](https://developer.android.com/jetpack/compose/kotlin#coroutines).

??? info "Migrating from GlideImage"
If you're migrating from Accompanist 0.7.x or before, please read the [migration](./migration-glideimage) documentation after reading this document.

## `rememberGlidePainter()`
Expand Down
2 changes: 1 addition & 1 deletion generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ sed -i.bak 's/$dokka.linkExtension:md/$dokka.linkExtension:html/g' package-list-
# Clear out the old API docs
[ -d docs/api ] && rm -r docs/api
# Build the docs with dokka
./gradlew clean dokkaHtmlMultiModule
./gradlew dokkaHtmlMultiModule

# Re-word the Dokka call out
find docs/api/ -type f -name '*.html' -exec sed -i -e 's/Sponsored and developed/Documentation generated/g' {} \;
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,4 @@ markdown_extensions:
- pymdownx.betterem
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.details

0 comments on commit d42a212

Please sign in to comment.