Backfill in-progress. Some lexicons and records may be missing or incomplete.

network.slices.tools.document

slices.network

Documentation

main record
Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

slug string Required

URL-friendly identifier, unique per author

maxLength: 100 bytes
title string Required

Document title

maxLength: 300 bytes
updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "slug",
      "blocks",
      "createdAt"
    ],
    "properties": {
      "slug": {
        "type": "string",
        "maxLength": 100,
        "description": "URL-friendly identifier, unique per author"
      },
      "title": {
        "type": "string",
        "maxLength": 300,
        "description": "Document title"
      },
      "blocks": {
        "type": "array",
        "items": {
          "refs": [
            "#paragraph",
            "#heading",
            "#codeBlock",
            "#quote",
            "#tangledEmbed",
            "#imageEmbed"
          ],
          "type": "union"
        },
        "description": "Document content as array of blocks"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      }
    }
  }
}
codeBlock object

A fenced code block

Properties

code string Required

No description provided.

maxLength: 20000 bytes
lang string Optional

No description provided.

maxLength: 50 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "maxLength": 20000
    },
    "lang": {
      "type": "string",
      "maxLength": 50
    }
  },
  "description": "A fenced code block"
}
heading object

A heading block (h1-h3) with optional inline formatting

Properties

level integer Required

No description provided.

minimum: 1maximum: 3
text string Required

No description provided.

maxLength: 300 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "level",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 300
    },
    "level": {
      "type": "integer",
      "maximum": 3,
      "minimum": 1
    },
    "facets": {
      "type": "array",
      "items": {
        "ref": "network.slices.tools.richtext.facet",
        "type": "ref"
      }
    }
  },
  "description": "A heading block (h1-h3) with optional inline formatting"
}
imageEmbed object

An embedded image with alt text

Properties

alt string Optional

Alt text for accessibility

maxLength: 1000 bytes
image blob Required

No description provided.

maxSize: 1.0 MB
View raw schema 
{
  "type": "object",
  "required": [
    "image"
  ],
  "properties": {
    "alt": {
      "type": "string",
      "maxLength": 1000,
      "description": "Alt text for accessibility"
    },
    "image": {
      "type": "blob",
      "accept": [
        "image/*"
      ],
      "maxSize": 1000000
    }
  },
  "description": "An embedded image with alt text"
}
paragraph object

A paragraph block with optional inline formatting

Properties

text string Required

No description provided.

maxLength: 10000 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 10000
    },
    "facets": {
      "type": "array",
      "items": {
        "ref": "network.slices.tools.richtext.facet",
        "type": "ref"
      }
    }
  },
  "description": "A paragraph block with optional inline formatting"
}
quote object

A blockquote with optional inline formatting

Properties

text string Required

No description provided.

maxLength: 5000 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "maxLength": 5000
    },
    "facets": {
      "type": "array",
      "items": {
        "ref": "network.slices.tools.richtext.facet",
        "type": "ref"
      }
    }
  },
  "description": "A blockquote with optional inline formatting"
}
tangledEmbed object

An embedded Tangled repo card

Properties

handle string Required

The repo owner's handle

maxLength: 300 bytes
repo string Required

The repository name

maxLength: 300 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "handle",
    "repo"
  ],
  "properties": {
    "repo": {
      "type": "string",
      "maxLength": 300,
      "description": "The repository name"
    },
    "handle": {
      "type": "string",
      "maxLength": 300,
      "description": "The repo owner's handle"
    }
  },
  "description": "An embedded Tangled repo card"
}

Lexicon Garden

@