nextauthjs / next-auth

Authentication for the Web.

https://authjs.dev

ISC License

22.49k stars 2.98k forks source link

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

Closed ndom91 closed 6 days ago

ndom91 commented 2 weeks ago

☕️ 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:

Potential new colors

Currently commented out, but still easily available in the /api/og/route.ts file:

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

🧢 Checklist

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

🎫 Affected issues

📌 Resources

vercel[bot] commented 2 weeks ago

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

codecov[bot] commented 2 weeks ago

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

```diff @@ 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.

github-actions[bot] commented 2 weeks ago

Broken Link Checker

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

socket-security[bot] commented 2 weeks ago

No dependency changes detected. Learn more about Socket for GitHub ↗︎

👍 No dependency changes detected in pull request