delucis/astro-og-canvas

Provide examples for using `bgImage`

Open

#76 opened on Oct 13, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (27 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (272 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Create usage examples for bgImage, including how to reference images from frontmatter with proper path resolution. Ensure to demonstrate the correct way to use the `bgImage` option with dynamic paths.
Tech stack
typescriptnodejs
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitAstroTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90