next-auth icon indicating copy to clipboard operation
next-auth copied to clipboard

chore(docs): add default `og:image`

Open ndom91 opened this issue 1 year ago โ€ข 5 comments

โ˜•๏ธ Reasoning

  • Add basic og:image endpoint (/api/og) and handler to generate images via next/og
  • Exposes title and description query params for custom text
    • title goes in the center box
    • description goes bottom right, across from "Auth.js" text (blank by default)
  • WIP initial design:

image

Example: https://auth-docs-git-ndom91-og-image-authjs.vercel.app/api/og

๐Ÿงข Checklist

  • [ ] Documentation
  • [ ] Tests
  • [ ] Ready to be merged

๐ŸŽซ Affected issues

๐Ÿ“Œ Resources

ndom91 avatar Apr 30 '24 18:04 ndom91

The latest updates on your projects. Learn more about Vercel for Git โ†—๏ธŽ

Name Status Preview Comments Updated (UTC)
auth-docs โœ… Ready (Inspect) Visit Preview ๐Ÿ’ฌ Add feedback May 10, 2024 4:50pm
2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
next-auth-docs โฌœ๏ธ Ignored (Inspect) Visit Preview May 10, 2024 4:50pm
proxy โฌœ๏ธ Ignored (Inspect) Visit Preview May 10, 2024 4:50pm

vercel[bot] avatar Apr 30 '24 18:04 vercel[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 37.51%. Comparing base (5e55331) to head (677a348).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10777   +/-   ##
=======================================
  Coverage   37.51%   37.51%           
=======================================
  Files         173      173           
  Lines       26983    26983           
  Branches     1176     1176           
=======================================
  Hits        10122    10122           
  Misses      16861    16861           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Apr 30 '24 18:04 codecov[bot]

Broken Link Checker

0 broken links found. Links organised below by source page, or page where they were found.

github-actions[bot] avatar May 01 '24 09:05 github-actions[bot]

No dependency changes detected. Learn more about Socket for GitHub โ†—๏ธŽ

๐Ÿ‘ No dependency changes detected in pull request

socket-security[bot] avatar May 01 '24 09:05 socket-security[bot]