DocShell.Presentation.Heading (DocShell v0.5.0)

Copy Markdown View Source

Identifies a heading after deterministic anchor projection.

The site projector stores the same id in the page AST and this value. A renderer therefore uses the supplied anchor for the heading, table of contents, and incoming links instead of deriving its own slug.

Summary

Types

t()

A stable heading anchor, plain-text title and HTML heading level.

Types

t()

@type t() :: %DocShell.Presentation.Heading{
  id: String.t(),
  level: 1..6,
  title: String.t()
}

A stable heading anchor, plain-text title and HTML heading level.