`media-providers`

The media-providers entry of ourbigbook.json specifies properties of how media such as images and videos are retrieved and rendered.

The general format of media-providers looks like:

"media-providers": {
  "github": {
    "default-for": ["image"], // "all" to default for both image, video and anything else
    "path": "data/media/",    // data is gitignored, but should not be nuked like _out/
    "remote": "ourbigbook/ourbigbook-media"
  },
  "local": {
    "default-for": ["video"],
    "path": "media/",
  },
  "youtube": {}
}

Properties that are valid for every provider:

default-for: use this provider as the default for the given types of listed macros.
The first character of the macros are case insensitive and must be given as lower case. Therefore e.g.:
- image applies to both image and Image
- giving Image is an error because that starts with an upper case character
title-from-src (bool): extract the title argument from the src by default for media such as images and videos as if the titleFromSrc macro argument had been given, see also: Section "Image ID"

Direct children of media-providers and subproperties that are valid only for them specifically:

local: tracked in the current Git repository as mentioned at Section "Store images inside the repository itself"
- path: location of the cloned local repository relative to the root the main repository
github: tracked in a separate Git repository as mentioned at Section "Store images in a separate media repository"
- path: analogous to path for local: a local location for this GitHub provider, where the repository can optionally be cloned.
  When not during a run with the --publish option, OurBigBook checks if the path exists locally, and if it does, then it uses that local directory as the source intead of the GitHub repository.
  This allows you to develop locally without Internet and see the latest version of the images without pushing them.
  During publishing, the GitHub version is used instead.
  TODO make this even more awesome by finishing to implement github.com/ourbigbook/ourbigbook/issues/184:
  automatically git push this repository during deployment to ensure that any asset changes will be available.
  ignore the path from OurBigBook conversion as if added to ignore, and is not added to the final output, because you are already going to have a copy of it.
  This way you can use the sanes approach which is to track the directory as a Git submodule as mentioned at: store images in a separate media repository and track it as a git submodule, instead of either:
  keeping it outside of the repository
  keeping it in the repository but explicitly ignoring it as well, which is a bit redundant
- remote: <github-username>/<repo-name>
youtube: YouTube videos

`media-providers`

 Ancestors (3)

 Incoming links (7)