Skip to content

Fix images not displaying in docs #133

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.

Sign up for GitHub

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

Merged
luizgrp merged 1 commit into from
May 10, 2022
+9 −9
Merged

Fix images not displaying in docs #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ UI and Data layers for media player. PlayScreen and individual UI components.

| PlayScreen |
|---|
| <img src="./docs/media-ui/playscreen.png" height="120" width="120" > |
| <img src="https://raw.githubusercontent.com/google/horologist/main/docs/media-ui/playscreen.png" height="120" width="120" > |

## 📅 Composables

Expand All @@ -21,7 +21,7 @@ High quality prebuilt composables, such as Time and Date pickers.

DatePicker | TimePickerWith12HourClock | TimePicker
:-------------------------:|:-------------------------:|:-------------------------:
<img src="https://github.com/google/horologist/blob/6b4a07a4d5cf010838b151e345860dca92c5490a/docs/composables/date_picker.png" height="120" width="120" > | <img src="https://github.com/google/horologist/blob/6b4a07a4d5cf010838b151e345860dca92c5490a/docs/composables/time_12h_picker.png" height="120" width="120"> | <img src="https://github.com/google/horologist/blob/6b4a07a4d5cf010838b151e345860dca92c5490a/docs/composables/time_24h_picker.png" height="120" width="120">
<img src="https://raw.githubusercontent.com/google/horologist/main/docs/composables/date_picker.png" height="120" width="120" > | <img src="https://raw.githubusercontent.com/google/horologist/main/docs/composables/time_12h_picker.png" height="120" width="120"> | <img src="https://raw.githubusercontent.com/google/horologist/main/docs/composables/time_24h_picker.png" height="120" width="120">

## 📐 Compose Layout

Expand All @@ -31,7 +31,7 @@ Layout related functionality such as a Navigation Aware Scaffold.

fillMaxRectangle() | fadeAway()
:-------------------------:|:-------------------------:
<img src="https://github.com/google/horologist/blob/6b4a07a4d5cf010838b151e345860dca92c5490a/docs/compose-layout/fill_max_rectangle.png" height="120" width="120" > | <img src="https://github.com/google/horologist/blob/6b4a07a4d5cf010838b151e345860dca92c5490a/docs/compose-layout/fade_away.png" height="120" width="120" >
<img src="https://raw.githubusercontent.com/google/horologist/main/docs/compose-layout/fill_max_rectangle.png" height="120" width="120" > | <img src="https://raw.githubusercontent.com/google/horologist/main/docs/compose-layout/fade_away.png" height="120" width="120" >

## 🔊 Audio and UI

Expand All @@ -43,7 +43,7 @@ Subscribing to a Flow of changes in audio or output.

VolumeScreen |
:-------------------------:|
<img src="https://github.com/google/horologist/blob/6b4a07a4d5cf010838b151e345860dca92c5490a/docs/audio-ui/volume_screen.png" height="120" width="120" > |
<img src="https://raw.githubusercontent.com/google/horologist/main/docs/audio-ui/volume_screen.png" height="120" width="120" > |

## 🖽 Tiles

Expand Down
8 changes: 4 additions & 4 deletions docs/media-playscreen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ This is a guide on how to use the stateful `PlayScreen` with your own implementa

## Basic usage

1. Implement PlayerRepository
##### 1. Implement PlayerRepository

```kotlin
class PlayerRepositoryImpl() : PlayerRepository {
// implement required properties and functions
}
```

2. Extend PlayerViewModel
##### 2. Extend PlayerViewModel

Pass your implementation of `PlayerRepository` as constructor parameter.

Expand All @@ -24,7 +24,7 @@ class MyCustomViewModel(
}
```

3. Add PlayScreen
##### 3. Add PlayScreen

Pass your `PlayerViewModel` extension as value to the constructor parameter.

Expand All @@ -36,4 +36,4 @@ PlayScreen(playerViewModel = myCustomViewModel)

The following diagram shows the interactions between the classes.

<img src="https://github.com/google/horologist/blob/main/docs/media/media_class_diagram.png" height="420" width="300" >
![](media_class_diagram.png){: loading=lazy align=center }
2 changes: 1 addition & 1 deletion docs/media-ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ There is a guide on the usage of the stateful `PlayScreen` [here][stateful playe

A sample usage of [PlayScreen][play screen] can be found in the [sample][sample app package] app in this project, in the [media][media screen sample package] package.

<img src="https://github.com/google/horologist/blob/main/docs/media-ui/playscreen.png" height="120" width="120" >
![](playscreen.png){: loading=lazy align=center }

## Download

Expand Down