Shoalrun documentation frameworkMenu
For agents
Start with https://www.shoalrun.com/llms.txt for the documentation index, then read the Markdown pages it links. Skip to article. Documentation index. Read this page as Markdown.
Code API reference

ContentAnchor

Mapping from a canonical document fragment to its exported HTML ID.

Updated
Read as Markdown

Type shoalrun.content.ContentAnchor

type ContentAnchor = {
    id: string;
    exportedId: string;
    title?: string;
};

Mapping from a canonical document fragment to its exported HTML ID.

Fields

Name Type Required / default Description
exportedId string Required —
id string Required —
title string | undefined Optional —

shoalrun.content.ContentAnchor.exportedId

Property shoalrun.content.ContentAnchor.exportedId

exportedId: string

Type: string

Required

shoalrun.content.ContentAnchor.id

Property shoalrun.content.ContentAnchor.id

id: string

Type: string

Required

shoalrun.content.ContentAnchor.title

Property shoalrun.content.ContentAnchor.title

title?: string | undefined

Type: string | undefined

Optional