Skip to main content

display-current-short-heading

Display the current short heading on the page.

Parameters

level : int | auto    default: auto

The level of the heading. If level is auto, it will return the last heading on or before the current page. If level is a number, it will return the last heading on or before the current page with the same level.

hierachical : bool    default: true

Whether to return the heading hierarchically. If true, returns the last heading according to the hierarchical structure. If false, returns the last heading on or before the current page with the same level.

depth : int    default: 9999

The maximum depth of the heading to search. Usually, it should be set as slide-level.

style : function

The style of the heading. If style is a function, it will use the function to style the heading. For example, style: (self: none, current-heading) => utils.short-heading(self: self, current-heading).

Returns: content