seo

Summary

Configuration namespace that holds all SEO related publishing settings.

Below is an overview of what the seo namespace looks like:

  publishing:
    seo:
      title:
      description:
      author:
      twitter:
      image:
        url:
        alt:

title

From Title

Go to text →

type: string
default: Dendron
required: false

Description

Set the title of the page.

Example

  publishing:
    seo:
      title: My Awesome Knowledge Base

description

From Description

Go to text →

type: string
default: Personal Knowledge Space
required: false

Description

Default description for the site.

If the note has a desc property, it will be overwritten by the content from desc

Example

publishing:
  seo:
    description: Everything I know

author

From Author

Go to text →

type: string
default: N/A
required: false

Description

Set the author.

Example

  publishing:
    seo:
      author: John Doe

twitter

From Twitter

Go to text →

type: string
default: N/A
required: false

Description

Set the Twitter handle.

Example

  publishing:
    seo:
      twitter: https://twitter.com/dendronhq

image

From Image

Go to text →

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