Provide examples for using `bgImage`

[paulrudy]

I'm struggling to use bgImage. Would you consider sharing an example of usage?

I'm not able to discover an explicit path that works. No matter what I try, I get no such file or directory. Edit: just needed ./src/path/to/image.png

What I'd like to do is pull the background image url from page frontmatter. For example, frontmatter contains:

featuredImage:
  url: '~/assets/image.png'

and in my getImageOptions() I have bgImage: {path: page.featuredImage?.url.src}, but I get [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string or an instance of Buffer or URL. Received undefined.

[delucis]

Hey @paulrudy! Thanks for your patience — finally getting through this backlog now.

Alias support like ~/ might be tricky — I’m not sure how to support that but glad you got the basic ./ relative path format working. Would welcome a PR if someone’s interested showing bgImage use. Hopefully I’ll get some time soon to work on some better documentation too, so it’s not just the README.