Link Search Menu Expand Document

Frontmatter

Dendron notes have frontmatter. Dendron Jekyll uses this frontmatter to configure various aspects about the appearance and publication status of a particular page.

Appearance

title: string

Title of the content. Control’s how the title shows up in the nav bar

sources: source[]

Automatically create attributions for a page

...
sources:
  - name: og-aws
    url: 'https://github.com/open-guides/og-aws'
    license: Creative Commons Attribution-ShareAlike 4.0 International License
  - name: Jerry Hargrove
    url: 'https://www.awsgeek.com/'
    license: Creative Commons Attribution-ShareAlike 4.0 International License

Publication

published: boolean

Specifies if the page should be published or not.

By default, everything under siteHierarchies is published unless publishByDefault is turned off. In that case, you must set published: true in order to publish a page under the given hierarchy.

You can also set this to false to selectively withhold specific pages from publication.

config

Per hierarchy specific config. To set options for all hierarchies, set {hiearchy name} to root.

config:
  {hierarchy name}: {hierarchy options}

The list of possible options:

  • publishByDefault: boolean, default: true
    • if set to false, dendron will only publish notes within the hierarchy that have published: true set in the frontmatter
  • noindexByDefault: boolean, default: false
    • if set to true, dendron will add the following meta tag <meta name="robots" content="noindex, nofollow”> which will tell google to not index your page
    • when google indexes a page, it will penalize sites that have duplicate content from other sites. this is useful if you are using your hiearchy as a cache
  • customFrontmatter: list, default: []
    • if set, dendron will add the specified frontmatter to each published note in the hierarchy. note that this will override existing keys with the same name when publishing
    • eg. add toc: true to all notes published under the iam.* hierarchy
      config:
        iam: 
            customFrontmatter: [
              {
                key: "toc",
                value: true,
              }
            ]