Skip to content

Commit

Permalink
[112] Various doc improvements
Browse files Browse the repository at this point in the history
- Move all card type assets into their own subfolders
- Fix link references to the multi library name support setting
- Remove unused footnotes
- Add python -m prefix to the non-Docker uv command in the tutorial
- Remove unused tautulli getting started file
- Create White Border card type docs
- Fix some extra links for various cards
- Remove unused old assets
  • Loading branch information
CollinHeist committed Nov 27, 2024
1 parent 914be4e commit 4f1b057
Show file tree
Hide file tree
Showing 116 changed files with 390 additions and 307 deletions.
Binary file removed docs/assets/home_dark.webp
Binary file not shown.
Binary file removed docs/assets/home_light.webp
Binary file not shown.
9 changes: 4 additions & 5 deletions docs/card_types/anime.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,8 @@ both the season and episode text.
### Color

The color of the episode text can be adjusted with the _Episode Text Color_
extra. This will also change the color of the [season text](#season-text), but
that can be overwritten with the [_Season Text Color_](#season-text-color)
extra.
extra. This will also change the color of the season text, but that can be
overwritten with the [_Season Text Color_](#season-text-color) extra.

??? example "Example"

Expand Down Expand Up @@ -113,7 +112,7 @@ as "Translate `Japanese` titles into `kanji`".
To go one step further, you can auto-assign this Template to a subset of
your Series when [Syncing](../user_guide/syncs.md); _or_ add the Template
with some filters (i.e. by library name) to your
[Global Templates](../user_guide/settings.md#...).
[Default Templates](../user_guide/settings.md#default-templates).

### Coloring

Expand Down Expand Up @@ -155,7 +154,7 @@ the text, and values less than `#!yaml 1.0` will decrease it.

The color of the stroke which surrounds the kanji text can be adjusted with the
_Kanji Stroke Color_ extra. If unspecified, the stroke color will match that of
the [title text](#stroke-color-2).
the [title text](#stroke-color_2).

??? example "Example"

Expand Down
Binary file removed docs/card_types/assets/anime-labeled.webp
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file removed docs/card_types/assets/white border.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/card_types/assets/white_border/labeled.webp
Binary file not shown.
Binary file not shown.
Binary file added docs/card_types/assets/white_border/mask.webp
Binary file not shown.
Binary file not shown.
6 changes: 4 additions & 2 deletions docs/card_types/calligraphy.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@ The color of this character will be controlled by the

<div class="image-compare example-card"
data-starting-point="56"
data-left-label="/" data-right-label="-">
data-left-label="/"
data-right-label="-">
<img src="../assets/calligraphy/separator.webp"/>
<img src="../assets/calligraphy.webp"/>
</div>
Expand All @@ -137,7 +138,8 @@ _Shadow Color_ extra.

<div class="image-compare example-card"
data-starting-point="50"
data-left-label="rgb(81, 124, 102)" data-right-label="black">
data-left-label="rgb(81, 124, 102)"
data-right-label="black">
<img src="../assets/calligraphy/shadow_color.webp"/>
<img src="../assets/calligraphy.webp"/>
</div>
Expand Down
Binary file removed docs/card_types/music-heart-fill.webp
Binary file not shown.
111 changes: 64 additions & 47 deletions docs/card_types/music.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ twenty available extra customizations.

??? note "Labeled Card Elements"

![Labeled Music Card Elements](./assets/music-labeled.webp)
![Labeled Music Card Elements](./assets/music/labeled.webp)

## Adjusting the Player Style

Expand All @@ -39,16 +39,18 @@ adjusting the _Player Style_ extra. This can be `basic`, `artwork`, `logo`, or

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="basic" data-right-label="artwork">
<img src="../assets/music-basic-style.webp"/>
data-left-label="basic"
data-right-label="artwork">
<img src="../assets/music/basic-style.webp"/>
<img src="../assets/music.webp"/>
</div>

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="logo" data-right-label="poster">
<img src="../assets/music-logo-style.webp"/>
<img src="../assets/music-poster-style.webp"/>
data-left-label="logo"
data-right-label="poster">
<img src="../assets/music/logo-style.webp"/>
<img src="../assets/music/poster-style.webp"/>
</div>

## Controls
Expand All @@ -62,9 +64,10 @@ setting the _Control Toggle_ extra as `True`.

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="False" data-right-label="True">
data-left-label="False"
data-right-label="True">
<img src="../assets/music.webp"/>
<img src="../assets/music-control.webp"/>
<img src="../assets/music/control.webp"/>
</div>

### Coloring
Expand All @@ -88,16 +91,18 @@ removed.

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="white crimson skyblue SeaGreen1 yellow" data-right-label="white white white white white">
<img src="../assets/music-control-colors.webp"/>
<img src="../assets/music-control.webp"/>
data-left-label="white crimson skyblue SeaGreen1 yellow"
data-right-label="white white white white white">
<img src="../assets/music/control-colors.webp"/>
<img src="../assets/music/control.webp"/>
</div>

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="rgb(29,185,84) none white none rgb(29,185,84)" data-right-label="white white white white white">
<img src="../assets/music-control-hidden.webp"/>
<img src="../assets/music-control.webp"/>
data-left-label="rgb(29,185,84) none white none rgb(29,185,84)"
data-right-label="white white white white white">
<img src="../assets/music/control-hidden.webp"/>
<img src="../assets/music/control.webp"/>
</div>


Expand All @@ -111,9 +116,10 @@ Card) will update any time the watched status of the Episode changes.

<div class="image-compare example-card"
data-starting-point="15.5"
data-left-label="pause" data-right-label="play">
<img src="../assets/music-control-pause.webp"/>
<img src="../assets/music-control.webp"/>
data-left-label="pause"
data-right-label="play">
<img src="../assets/music/control-pause.webp"/>
<img src="../assets/music/control.webp"/>
</div>

## Heart Icon
Expand All @@ -135,9 +141,10 @@ Toggle_ extra as `True`.

<div class="image-compare example-card"
data-starting-point="28"
data-left-label="False" data-right-label="True">
data-left-label="False"
data-right-label="True">
<img src="../assets/music.webp"/>
<img src="../assets/music-heart-toggle.webp"/>
<img src="../assets/music/heart-toggle.webp"/>
</div>

### Coloring
Expand All @@ -153,19 +160,21 @@ while not appearing "selected."

<div class="image-compare example-card"
data-starting-point="27.7"
data-left-label="white" data-right-label="rgb(29,185,84)">
<img src="../assets/music-heart-toggle.webp"/>
<img src="../assets/music-heart-stroke.webp"/>
data-left-label="white"
data-right-label="rgb(29,185,84)">
<img src="../assets/music/heart-toggle.webp"/>
<img src="../assets/music/heart-stroke.webp"/>
</div>

The following shows an adjustment to the _Heart Stroke Color_ __and__
_Heart Fill Color_ extras.

<div class="image-compare example-card"
data-starting-point="27.7"
data-left-label="white" data-right-label="#FF2733">
<img src="../assets/music-heart-toggle.webp"/>
<img src="../assets/music-heart-fill.webp"/>
data-left-label="white"
data-right-label="#FF2733">
<img src="../assets/music/heart-toggle.webp"/>
<img src="../assets/music/heart-fill.webp"/>
</div>

## Timeline
Expand All @@ -180,9 +189,10 @@ _Timeline Color_ extra. This only applies to the filled portion - e.g. the

<div class="image-compare example-card"
data-starting-point="10"
data-left-label="rgb(29,185,84)" data-right-label="skyblue">
data-left-label="rgb(29,185,84)"
data-right-label="skyblue">
<img src="../assets/music.webp"/>
<img src="../assets/music-timeline-color.webp"/>
<img src="../assets/music/timeline-color.webp"/>
</div>

### Filled Percentage
Expand Down Expand Up @@ -231,9 +241,10 @@ either `left`, `middle` or `right`.

<div class="image-compare example-card"
data-starting-point="66"
data-left-label="middle" data-right-label="right">
<img src="../assets/music-middle-position.webp"/>
<img src="../assets/music-right-position.webp"/>
data-left-label="middle"
data-right-label="right">
<img src="../assets/music/middle-position.webp"/>
<img src="../assets/music/right-position.webp"/>
</div>

### Player Inset
Expand All @@ -246,9 +257,10 @@ and vertical spacing.

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="50" data-right-label="150">
data-left-label="50"
data-right-label="150">
<img src="../assets/music.webp"/>
<img src="../assets/music-inset-150.webp"/>
<img src="../assets/music/inset-150.webp"/>
</div>

## Player Width
Expand All @@ -261,9 +273,10 @@ dynamically resized with the specified width.

<div class="image-compare example-card"
data-starting-point="33"
data-left-label="900" data-right-label="1200">
data-left-label="900"
data-right-label="1200">
<img src="../assets/music.webp"/>
<img src="../assets/music-width-1200.webp"/>
<img src="../assets/music/width-1200.webp"/>
</div>

## Player Color
Expand All @@ -275,9 +288,10 @@ Color_ extra.

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="rgba(0,0,0,0.50)" data-right-label="rgba(120,120,120,0.50)">
data-left-label="rgba(0,0,0,0.50)"
data-right-label="rgba(120,120,120,0.50)">
<img src="../assets/music.webp"/>
<img src="../assets/music-background-alt.webp"/>
<img src="../assets/music/background-alt.webp"/>
</div>

## Subtitle Text
Expand All @@ -303,9 +317,10 @@ completely. See the full list of available variables

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="{series_name}" data-right-label="{series_full_name}">
<img src="../assets/music-control.webp"/>
<img src="../assets/music-subtitle.webp"/>
data-left-label="{series_name}"
data-right-label="{series_full_name}">
<img src="../assets/music/control.webp"/>
<img src="../assets/music/subtitle.webp"/>
</div>

## Album Image Corner Rounding
Expand All @@ -320,9 +335,10 @@ This can be disabled by setting the _Round Album Corners Toggle_ extra to

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="True" data-right-label="False">
<img src="../assets/music-control.webp"/>
<img src="../assets/music-rounded.webp"/>
data-left-label="True"
data-right-label="False">
<img src="../assets/music/control.webp"/>
<img src="../assets/music/rounded.webp"/>
</div>

## Title Line Truncation
Expand All @@ -339,9 +355,10 @@ this to `False` will stop truncation altogether.

<div class="image-compare example-card"
data-starting-point="15"
data-left-label="2" data-right-label="3">
<img src="../assets/music-truncate-2.webp"/>
<img src="../assets/music-truncate-3.webp"/>
data-left-label="2"
data-right-label="3">
<img src="../assets/music/truncate-2.webp"/>
<img src="../assets/music/truncate-3.webp"/>
</div>

## Mask Images
Expand All @@ -357,6 +374,6 @@ effects.
data-starting-point="30"
data-left-label="Mask Image"
data-right-label="Resulting Title Card">
<img src="../assets/music-mask-raw.webp"/>
<img src="../assets/music-mask.webp"/>
<img src="../assets/music/mask-raw.webp"/>
<img src="../assets/music/mask.webp"/>
</div>
40 changes: 24 additions & 16 deletions docs/card_types/negative_space.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ and is based the video transitions in

??? note "Labeled Card Elements"

![Labeled Negative Space Card Elements](./assets/negative_space-labeled.webp)
![Labeled Negative Space Card Elements](./assets/negative_space/labeled.webp)

## Text Positioning

Expand All @@ -32,9 +32,10 @@ TCM will randomly select a side when the Card is generated.

<div class="image-compare example-card"
data-starting-point="50"
data-left-label="left" data-right-label="right">
data-left-label="left"
data-right-label="right">
<img src="../assets/negative_space.webp"/>
<img src="../assets/negative_space-side.webp"/>
<img src="../assets/negative_space/side.webp"/>
</div>

## Episode Text Adjustments
Expand All @@ -51,9 +52,10 @@ extra. If unspecified, it defaults to matching the font color.

<div class="image-compare example-card"
data-starting-point="11.9"
data-left-label="white" data-right-label="MediumGoldenRod">
data-left-label="white"
data-right-label="MediumGoldenRod">
<img src="../assets/negative_space.webp"/>
<img src="../assets/negative_space-etc.webp"/>
<img src="../assets/negative_space/episode_text_color.webp"/>
</div>

### Size
Expand All @@ -66,9 +68,10 @@ decrease it.

<div class="image-compare example-card"
data-starting-point="11.9"
data-left-label="1.0" data-right-label="0.8">
data-left-label="1.0"
data-right-label="0.8">
<img src="../assets/negative_space.webp"/>
<img src="../assets/negative_space-etfs.webp"/>
<img src="../assets/negative_space/episode_text_font_size.webp"/>
</div>

### Position
Expand All @@ -87,9 +90,10 @@ will be positioned slightly differently than `61` (starting with `6`).

<div class="image-compare example-card"
data-starting-point="11.9"
data-left-label="0" data-right-label="200">
data-left-label="0"
data-right-label="200">
<img src="../assets/negative_space.webp"/>
<img src="../assets/negative_space-eths.webp"/>
<img src="../assets/negative_space/episode_text_horizontal_shift.webp"/>
</div>

#### Vertical Shift
Expand All @@ -102,9 +106,10 @@ down, and negative values shift it up.

<div class="image-compare example-card"
data-starting-point="11.9"
data-left-label="0" data-right-label="300">
data-left-label="0"
data-right-label="300">
<img src="../assets/negative_space.webp"/>
<img src="../assets/negative_space-etvs.webp"/>
<img src="../assets/negative_space/episode_text_vertical_shift.webp"/>
</div>

## Title Text Horizontal Shift
Expand All @@ -116,9 +121,10 @@ _Title Text Horizontal Shift_ extra.

<div class="image-compare example-card"
data-starting-point="11.9"
data-left-label="0" data-right-label="250">
data-left-label="0"
data-right-label="250">
<img src="../assets/negative_space.webp"/>
<img src="../assets/negative_space-tths.webp"/>
<img src="../assets/negative_space/title_text_horizontal_shift.webp"/>
</div>

## Mask Images
Expand All @@ -132,7 +138,9 @@ effects.

<div class="image-compare example-card"
data-starting-point="14.25"
data-left-label="Mask Image" data-right-label="Resulting Title Card">
<img src="../assets/negative_space-mask-raw.webp"/>
<img src="../assets/negative_space-mask.webp"/>
data-left-label="Mask Image"
data-right-label="Resulting Title Card">
<img src="../assets/negative_space/mask-raw.webp"/>
<img src="../assets/negative_space/mask.webp"/>
</div>
Loading

0 comments on commit 4f1b057

Please sign in to comment.