Renderer Partials (renderers)

JSON Schema

{
  "$id": "https://platen.io/modules/platen/config/site/features/renderers/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Registers one or more partials that act as render hooks.\n\nhttps://platen.io/modules/platen/config/site/features/renderers/",
  "properties": {
    "codeblock": {
      "description": "Adds a partial to call when processing the codeblock render hook.\n\nhttps://platen.io/modules/platen/config/site/features/renderers/#codeblock",
      "title": "Codeblock Render Hook Partial",
      "type": "string"
    },
    "heading": {
      "description": "Adds a partial to call when processing the heading render hook.\n\nhttps://platen.io/modules/platen/config/site/features/renderers/#heading",
      "title": "Heading Render Hook Partial",
      "type": "string"
    },
    "image": {
      "description": "Adds a partial to call when processing the image render hook.\n\nhttps://platen.io/modules/platen/config/site/features/renderers/#image",
      "title": "Image Render Hook Partial",
      "type": "string"
    },
    "link": {
      "description": "Adds a partial to call when processing the link render hook.\n\nhttps://platen.io/modules/platen/config/site/features/renderers/#link",
      "title": "Link Render Hook Partial",
      "type": "string"
    }
  },
  "title": "Renderer Partials",
  "type": "object"
}

Codeblock Render Hook Partial (codeblock)

If specified, this partial is processed when a fenced codeblock with a language ID is rendered from Markdown. This support is in addition to Hugo’s normal method for adding codeblock render hooks per language.

In Platen, codeblock render hook partials registered by features are processed one at a time for each enabled feature with a defined codeblock render hook partial until one of them returns a non-empty string representing the rendered content.

If no codeblock render hook partial returns a rendered string, the default codeblock render hook is called instead. The first codeblock render hook partial to return a non-empty string ends the render hook processing. Any remaining render hook partials are never processed for that codeblock.

A feature can only define one codeblock render hook partial.

For more information about defining codeblock render hook partials, see Defining a Codeblock Render Hook Partial in the Theme Guide.

Heading Render Hook Partial (heading)

If specified, this partial is processed when a heading is rendered from Markdown. This support allows you to extend the default heading render hook without replacing it. You can still define additional heading render hooks on a per-output-format basis, like a custom heading output for content in an RSS feed.

In Platen, heading render hook partials registered by features are processed one at a time for each enabled feature with a defined heading render hook partial until one of them returns a non-empty string representing the rendered content.

If no heading render hook partial returns a rendered string, the default heading render hook is called instead. The first heading render hook partial to return a non-empty string ends the render hook processing. Any remaining render hook partials are never processed for that heading.

A feature can only define one heading render hook partial.

For more information about defining heading render hook partials, see Defining a Heading Render Hook Partial in the Theme Guide.

Image Render Hook Partial (image)

If specified, this partial is processed when a image is rendered from Markdown. This support allows you to extend the default image render hook without replacing it. You can still define additional image render hooks on a per-output-format basis, like a custom image output for content in an RSS feed.

In Platen, image render hook partials registered by features are processed one at a time for each enabled feature with a defined image render hook partial until one of them returns a non-empty string representing the rendered content.

If no image render hook partial returns a rendered string, the default image render hook is called instead. The first image render hook partial to return a non-empty string ends the render hook processing. Any remaining render hook partials are never processed for that image.

A feature can only define one image render hook partial.

For more information about defining image render hook partials, see Defining a Heading Render Hook Partial in the Theme Guide.

Link Render Hook Partial (link)

If specified, this partial is processed when a link is rendered from Markdown. This support allows you to extend the default link render hook without replacing it. You can still define additional link render hooks on a per-output-format basis, like a custom link output for content in an RSS feed.

In Platen, link render hook partials registered by features are processed one at a time for each enabled feature with a defined link render hook partial until one of them returns a non-empty string representing the rendered content.

If no link render hook partial returns a rendered string, the default link render hook is called instead. The first link render hook partial to return a non-empty string ends the render hook processing. Any remaining render hook partials are never processed for that link.

A feature can only define one link render hook partial.

For more information about defining link render hook partials, see Defining a Heading Render Hook Partial in the Theme Guide.