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

Description

Set the URL the site will be published under. All links will be prefixed with this URL.

siteUrl will always be the base URL, while assetsPrefix may need to be used when using publishing services like GitHub Pages, GitLab Pages, and others when you aren't using a custom domain name.

Example

If you are publishing with a custom domain, such as https://example.com, siteUrl will be that URL.

  publishing:
    siteUrl: https://example.com

• type: string
• default: docs
• required: true

Description

Set the directory where your website will be built. This path is relative to your workspace root.

Example

  publishing:
    siteRootDir: docs # will build site under {workspace root}/docs/

• type: string
• default: first element of siteHierarchies (Private)
• required: false

Description

Set the note that will be the home of your published site.

Example

  publishing:
    siteIndex: foo
    siteHierarchies:
      - dendron
      - foo
      - bar

• type: string[]
• default: [root]
• required: true

Description

Set the list of hierarchies to publish

NOTE: root is a special value. When this is set, all hierarchies are published. If you want to publish specific hierarchies, remove root and list out hierarchies that you want to publish

Example

• publishing all notes

  publishing:
    siteHierarchies:
      - root

• publishing specific colors

  publishing:
    siteHierarchies:
      - dendron
      - community
      - topic

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

Description

Set per-hierarchy publishing configurations.

For each hierarchy you wish to configure, you can set the hierarchy name as the key and use the following properties:

• publishByDefault
• customFrontmatter

Example

publishing:
  hierarchy:
    fooHiearchy:
      publishByDefault: ...
      customFrontmatter: ...

• type: boolean
• default: true
• required: false

Description

Enable rendering frontmatter property title as title of the note.

Example

  publishing:
    enableFMTitle: false

• type: boolean
• default: true
• required: false

Description

Enable rendering note references as pretty refs in published notes.

See Pretty Ref for more information.

Example

  publishing:
    enablePrettyRefs: true

• type: boolean
• default: true
• required: true

Description

Enable displaying the last modified date at the bottom of your published notes.

Example

  publishing:
    enableSiteLastModified: false

• type: boolean
• default: true
• required: false

Description

Enable using note titles when displaying naked links in a published note.

This also applies to note references.

If set to false, the entire hierarchy string will be used for rendering the links.

Example

  publishing:
    enableNoteTitleForLink: true

• type: boolean
• default: true
• required: false

Description

Enable rendering hierarchies (Children) list at the end of the note.

The text used for the title of the block can be set by hierarchyDisplayTitle

Example

  publishing:
    enableHierarchyDisplay: true
    hierarchyDisplayTitle: Children

• type: boolean
• default: true
• required: false

Description

Enable rendering Katex typesetting in published notes.

See Math for more information.

Example

  publishing:
    enableKatex: true

❗ Note that currently this will also affect how frontmatter tags will be rendered in Preview. This will later be fixed.

• type: boolean
• default: true
• required: true

Description

Enable rendering frontmatter tags in published notes.

See Frontmatter tags for more information.

Example

  publishing:
    enableFrontmatterTags: false

❗ Note that currently this will also affect how frontmatter tags will be rendered in Preview. This will later be fixed.

• type: boolean
• default: false
• required: true

Description

Enable rendering frontmatter tags with the # symbol prefix in published notes.

See Frontmatter tags for more information.

Example

  publishing:
    enableFrontmatterTags: true
    enableHashesForFMTags: true

❗ Note that currently this will also affect how tags will be rendered in Preview. This will later be fixed.

• type: boolean
• default: true
• required: false

Description

Enable automatically generated colors for tags when the tag color isn't specified.

If disabled, only the tags that have colors explicitly set will have the color rendered, and the rest will be rendered identical to regular links.

Example

  publishing:
    enableRandomlyColoredTags: false

❗ Note that currently this will also affect how tags will be rendered in Preview. This will later be fixed.

• type: boolean
• default: true
• required: false

Description

When enabled, links to task notes will have a checkmark, and will display task owner and due date. You can disable this view by setting this configuration to false.

Example

publishing:
  enableTaskNotes: false

• type: boolean
• default: true
• required: false

Description

Copy assets from vault to published website.

Example

  publishing:
    copyAssets: true

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

Description

Prefix all urls with the given prefix

By default, assets are served from the root (/). Adding an assetsPrefix will change the url that pages are served from.

Example

# in this case, it will serve requests from /foo
publishing:
  assetsPrefix: foo

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

Description

Set the path to a logo image.

The logo will appear in the site header, and will be used as a default image if no image frontmatter property is set for a published note.

The value can be either:

• a path, which will be relative to the workspace root.
• a web URL starting with http or https, in which case Dendron will use the provided URL as-is.

Example

  publishing:
    logoPath: https://example.com/logo

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

Description

Set the path to favicon.

The value is relative to the workspace root.

Example

  publishing:
    siteFaviconPath: public

• type: boolean
• default: false
• required: true

Description

Set how stub notes are handled when publishing.

If set to true, all stub notes that are getting published will be written to the file system as an empty note in your vault. Writing stubs will guarantee a permanent URL for the published stub notes.

If set to false, stub notes will not be written to the file system. Note that any link to the stub notes will not be permanent, and will be randomized every time it is published. This is because a stub note that isn't written to the filesystem will always have a randomly generated temporary note id.

See Stubs for more information.

Example

  publishing:
    writeStubs: true

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

Description

Set the path to a custom header file which will be included in all published pages.

This path is relative to the workspace root.

Example

  publishing:
    customHeaderPath: header.html

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

Description

Set the strategy to handle duplicate notes in a multi-vault workspace.

Currently, only the useVault action is allowed.

It takes a list of vault names as payload. When a duplicate is found, Dendron will go through the provided list sequentially and resolve to the first vault that matches.

Note that this is done automatically when you run the Vault Add command.

Example

If a duplicate note is found, try resolving them in vault1 first, then followed by vault2 and then finally vault3.

publishing: 
  duplicateNoteBehavior: # if a duplcate note is found,
    action: useVault
    payload: # try resolving them in this order of vault match
      - vault1
      - vault2
      - vault3

• type: string
• default: Children
• required: false

Description

Set the text to be used as the heirarchy display block's title.

enableHierarchyDisplay needs to be enabled for this to be in effect.

Example

  publishing:
    enableHierarchyDisplay: true
    hierarchyDisplayTitle: Children

❗ Please note that, we (Dendron as an organization) do not track analytics on user's personal published sites. This configuration option is for providing your own tracking number if you wish to do so for your own purposes.

Description

Configuration namespace that holds all Google Analytics related publishing settings.

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

  publishing:
    ga:
      tracking:

tracking

  publishing:
    ga:
      tracking: UA-000000-2

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

  publishing:
    seo:
      title: My Awesome Knowledge Base

description

publishing:
  seo:
    description: Everything I know

author

  publishing:
    seo:
      author: John Doe

twitter

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

image

image:
  url: string, uri to the image
  alt: string, alt text of the 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

---
...
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

Summary

Configuration namespace that holds all GitHub related publishing settings.

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

publishing:
  github:
    cname:
    enableEditLink:
    editLinkText:
    editViewMode:
    editBranch:
    editRepository:

cname

  publishing:
    github:
      cname: wiki.dendron.so

enableEditLink

  publishing:
    github:
      enableEditLink: true

editLinkText

  publishing:
    github:
      enableEditLink: true
      editLinkText: Click here to edit this note

editViewMode

  publishing:
    github:
      editViewMode: `edit`

editBranch

  publishing:
    github:
      editBranch: staging

editRepository

  publishing:
    github:
      editRepository: https://github.com/dendronhq/dendron-site

All required fields in this configuration namespace can be generated through the configuration tool

To learn more about Giscus, please refer to Giscus

Summary

Configuration namepsace that holds all Giscus related publishing settings.

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

publishing:
  giscus:
    id:
    host:
    repo:
    repoId:
    category:
    categoryId:
    mapping:
    term:
    theme:
    strict:
    reactionsEnabled:
    emitMetadata:
    inputPosition:
    lang:
    loading:

id

  publishing:
    giscus:
      id: comments

host

  publishing:
    giscus:
      host: my-custom-host.com

repo

  publishing:
    giscus:
      repo: "dendronhq/dendron-site"

repoId

  publishing:
    giscus:
      repoId: "1234567890"

category

  publishing:
    giscus:
      category: "Announcements"

categoryId

  publishing:
    giscus:
      categoryId: "1234567890"

mapping

  publishing:
    giscus:
      mapping: "pathname"

term

  publishing:
    giscus:
      term: "term"

theme

  publishing:
    giscus:
      theme: preferred_color_scheme

strict

  publishing:
    giscus:
      strict: "0"

reactionsEnabled

  publishing:
    giscus:
      reactionsEnabled: "1"

emitMetadata

  publishing:
    giscus:
      emitMetadata: "0"

inputPosition

  publishing:
    giscus:
      inputPosition: "top"

lang

  publishing:
    giscus:
      lang: "en"

loading

  publishing:
    giscus:
      loading: "lazy"

• type: boolean
• default: false
• frontmatter: only

Description

Should exclude children from the published tree view

• NOTE: this is on by default if has_collection is set to true

Example

nav_exclude_children: false

nav_exclude_children: true