Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 23 commits into from May 10, 2024
Merged

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

merged 23 commits into from May 10, 2024

Conversation

ndom91
Copy link
Member

@ndom91 ndom91 commented Apr 30, 2024

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

Potential new colors

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

image

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

🧢 Checklist

  • Documentation
  • Tests
  • Ready to be merged

🎫 Affected issues

📌 Resources

Copy link

vercel bot commented Apr 30, 2024

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

Copy link

codecov bot commented Apr 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

github-actions bot commented May 1, 2024

Broken Link Checker

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

Copy link

socket-security bot commented May 1, 2024

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

👍 No dependency changes detected in pull request

@ndom91 ndom91 merged commit 4dda6af into main May 10, 2024
14 of 15 checks passed
@ndom91 ndom91 deleted the ndom91/og-image branch May 10, 2024 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant