diff --git a/README.md b/README.md index 83edea3..ce31450 100644 --- a/README.md +++ b/README.md @@ -51,4 +51,14 @@ links: - text: "My Twitter" url: "https://twitter.com/example" ``` -This will include the links in the article page. The links will be displayed as a list with the text as the link text and the URL as the link target. \ No newline at end of file +This will include the links in the article page. The links will be displayed as a list with the text as the link text and the URL as the link target. + +### Open Graph Image + +You can add Open Graph image (for social media sharing) to an article. To do this, add a `ogImage` field to the front matter of the article. The value should be the path to the image file. For example: + +```yaml +ogImage: "/images/my-image.jpg" +``` + +*Note: The image should be at least 1200x630 pixels for best results. Make sure to place the image in `/static/images/` directory so it can be served correctly. The path should be relative to the static directory.* \ No newline at end of file diff --git a/config.toml b/config.toml index c337624..0926139 100644 --- a/config.toml +++ b/config.toml @@ -12,7 +12,7 @@ title = 'Protocol Oral History Project' [params] description = "The Protocol Oral History Project chronicles the development of internet protocols and standards through interviews with key contributors." - images = ["/images/default-og.jpg"] # Will be replaced by wompum generation + openGraphImage = "/images/og-default.jpg" twitterSite = "" facebookAppID = "" footer = """ diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html index a843579..08a39f7 100644 --- a/layouts/_default/baseof.html +++ b/layouts/_default/baseof.html @@ -15,7 +15,7 @@ {{ end }} -