- /
-
- Configuration /
- Open Graph Image - Configuration
Open Graph Image - Configuration
Set the image displayed when visitors share your pages
2025-05-23
ITADS
Default Open Graph URL is the LibDoc’s Open Graph image. To assign your own default Open Graph URL, enter it into settings.json
:
{
"ogImageUrl": "https://<YOUR_OWN_PUBLIC_ABSOLUTE_URL>.jpg"
}
The Open Graph Image is a metadata image URL that is displayed when a link to a LibDoc page is shared into a social network. By default, LibDoc configation ogImageUrl
is used on every page but this parameter can be overridden on each page’s front matter with the same key ogImageUrl
. Then you can customize each page of your project.
Open Graph Image URL is applied following these ordered priorities:
- By default Open Graph Image URL’s value is
libdocConfig.ogImageUrl
if nothing is set into the front matter. - If
ogImageUrl
is set into the front matter and the page is not a blog post, page’s Open Graph Image URL gets this value.
Learn more about Open Graph.