coop.hypha.spores.site.section

hypha.coop

Documentation

A single site section for spores.garden. Each section is a record in a collection.

main record

A single site section for spores.garden. Each section is a record in a collection.

Record Key tid Timestamp-based ID

Properties

collection string Optional

Collection NSID to display (for type=collection)

content string Optional

Content for block sections

maxLength: 500000 bytesmaxGraphemes: 50000 graphemes
format string Optional

Content format

Known values: markdown, html, text
hideHeader boolean Optional

If true, hides the section header in display mode

layout string Optional

Layout to use for rendering

Known values: post, card, image, link, links, list, profile, raw
limit integer Optional

Maximum records to display

minimum: 1maximum: 100
records array of string at-uri Optional

Specific record URIs to display (for type=records)

ref string at-uri Optional

AT-URI of the referenced record (for content/profile sections)

rkey string Optional

Record key within the collection to display (e.g. 'self' for profile)

title string Optional

Section title

maxLength: 2000 bytesmaxGraphemes: 200 graphemes
type string Required

Section type

Known values: collection, records, content, block, profile, share-to-bluesky, collected-flowers
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "type"
    ],
    "properties": {
      "ref": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the referenced record (for content/profile sections)"
      },
      "rkey": {
        "type": "string",
        "description": "Record key within the collection to display (e.g. 'self' for profile)"
      },
      "type": {
        "type": "string",
        "description": "Section type",
        "knownValues": [
          "collection",
          "records",
          "content",
          "block",
          "profile",
          "share-to-bluesky",
          "collected-flowers"
        ]
      },
      "limit": {
        "type": "integer",
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum records to display"
      },
      "title": {
        "type": "string",
        "maxLength": 2000,
        "description": "Section title",
        "maxGraphemes": 200
      },
      "format": {
        "type": "string",
        "description": "Content format",
        "knownValues": [
          "markdown",
          "html",
          "text"
        ]
      },
      "layout": {
        "type": "string",
        "description": "Layout to use for rendering",
        "knownValues": [
          "post",
          "card",
          "image",
          "link",
          "links",
          "list",
          "profile",
          "raw"
        ]
      },
      "content": {
        "type": "string",
        "maxLength": 500000,
        "description": "Content for block sections",
        "maxGraphemes": 50000
      },
      "records": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "at-uri"
        },
        "description": "Specific record URIs to display (for type=records)"
      },
      "collection": {
        "type": "string",
        "description": "Collection NSID to display (for type=collection)"
      },
      "hideHeader": {
        "type": "boolean",
        "description": "If true, hides the section header in display mode"
      }
    }
  },
  "description": "A single site section for spores.garden. Each section is a record in a collection."
}

Lexicon Garden

@