github

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

From Cname

Go to text →

type: string
default: N/A
required: false

Description

Set the CNAME used for GitHub Pages publishing.

Example

  publishing:
    github:
      cname: wiki.dendron.so

enableEditLink

From enableEditLink

Go to text →

type: boolean
default: true
required: true

Description

Enable adding a link at the bottom of a published page that lets users edit the page.

Example

  publishing:
    github:
      enableEditLink: true

editLinkText

From editLinkText

Go to text →

type: string
default: Edit this page on GitHub
required: false

Description

Set the text to be used with the edit link when enabled by enableEditLink.

enableEditLink needs to be set to true for this to take effect.

Example

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

editViewMode

From editViewMode

Go to text →

type: tree | edit
default: tree
required: false

Description

Set how the users should be redirected when clicking on the edit link.

tree mode will open the note's location in the repository.
edit mode will open an editor that could be used to commit / create pull request with changes.

Example

  publishing:
    github:
      editViewMode: `edit`

editBranch

From editBranch

Go to text →

type: string
default: main
required: false

Description

Set the branch that the edit link should redirect to.

Example

  publishing:
    github:
      editBranch: staging

editRepository

From editRepository

Go to text →

type: string
default: N/A
required: false

Description

Set the URL of the project's GitHub repository.

This will be used to redirect users to the correct repository when the edit link is clicked.

Example

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

Backlinks