Image

• type: object
• default: N/A
• required: false

Description

Set the default image for the published site.

The image will show up in preview on social media websites. If this isn't configured, no image will be used when sharing links to pages on the published site.

Images can also be set at the note level with, and are configured with the same settings (url, alt). Images at the note level will override the default image set in dendron.yml.

Syntax

image:
  url: string, uri to the image
  alt: string, alt text of the image

Examples

Setting site wide image

publishing:
  seo:
    image:
      url: https://org-dendron-public-assets.s3.amazonaws.com/images/blog-mobile-editor-header.png
      alt: A tree with many branches in full bloom

Setting a note specific image

---
...
image:
  url: https://org-dendron-public-assets.s3.amazonaws.com/images/blog-mobile-editor-header.png
  alt: A tree with many branches in full bloom
---

Blog header

---

Backlinks

• Configuration
• seo