Skip to content

Commit

Permalink
Begin v1 TMDb docs
Browse files Browse the repository at this point in the history
  • Loading branch information
CollinHeist committed Nov 14, 2024
1 parent 07da0b6 commit 97b20bc
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
28 changes: 28 additions & 0 deletions docs/v1/prefs/tmdb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: TMDb Settings (v1)
description: >
How to connect TCM to TheMovieDatabase (TMDb).
---

# TMDb

## Background

This is an optional YAML section of your [global preferences file](...)
(`preferences.yml`) for outlining how TCM interacts with the public database
service, [TMDb](themoviedb.org). TMDb is used for many things by TCM, but
notably the following:

- Automatically downloading source image files for use in title cards
- Automatically downloading logos for title cards and summaries
- Automatically adding episode title translations to data files

## Recommended Setup

```yaml title="preferences.yml"
tmdb:
api_key: # (1)!
```
1. Place your own TMDb-provided API key here
2 changes: 1 addition & 1 deletion docs/v1/translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ In addition to this feature, which all card types support, the
[Anime](./card_types/anime.md) card type also allows for displaying the
Japanese titles (as kanji) on the card.

In order to use this setting, [TMDB](./config/tmdb.md) __must__ be enabled.
In order to use this setting, [TMDB](./prefs/tmdb.md) __must__ be enabled.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ nav:
- Version 1:
- v1/index.md
- Configuration:
- TMDb: v1/config/tmdb.md
- TMDb: v1/prefs/tmdb.md
- Sync: v1/sync.md
- Translation: v1/translation.md
- Card Types:
Expand Down

0 comments on commit 97b20bc

Please sign in to comment.