facebook / facebook/docusaurus

RFC: social cards

Open
#2,968 56 comments 10 reactions 0 assignees View on GitHub
feature
Dominant language
TypeScript
Stars
66.2k
Forks
10k
Avg merge
1d 3h
Merged PRs (30d)
52

Description

Issue for idea already expressed here: https://github.com/facebook/docusaurus/issues/2267#issuecomment-639597335

# Dynamic Social Cards

You might have noticed that some people / companies have an automated way to generate social cards that adapt to the underlying content (generating an image from query string params)

I think this would cool if by default, all Docusaurus docs/blogs would generate custom social cards, if the user did not define any custom social image.

This way, all Docusaurus links pasted to a social media would have a beautiful image.

By default we could even include a discrete Docusaurus + Slash logo for growth hacking 🤪

Vercel has a nice project to do this easily: https://github.com/vercel/og-image

We could fork this project, host our own variant (can be free on Vercel), and use it for D2 website, + allow other sites to use it as well.

Curretly, Docusaurus can have a default social card, but it's static and does not adapt to the content::

![image](https://user-images.githubusercontent.com/749374/83898560-5fd4db00-a757-11ea-8021-7442ed6fa4c5.png)

Here's some examples of dynamic/automated social cards:

![image](https://user-images.githubusercontent.com/749374/83897173-872aa880-a755-11ea-9cf5-dba1ecd7264a.png)

![image](https://user-images.githubusercontent.com/749374/83897249-a3c6e080-a755-11ea-875e-caec89b0c5ff.png)

![image](https://user-images.githubusercontent.com/749374/83897287-b214fc80-a755-11ea-8aa1-29eadf578d8f.png)

![image](https://user-images.githubusercontent.com/749374/83897394-d5d84280-a755-11ea-8f19-ff284d8ebc50.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.