Document Metadata
The attributes of a document, merged from its Changes: the keys Seed understands, the three schema-binding keys, and any custom keys a typed document adds.- name
- Document Metadata
- summary
- The attributes of a document, merged from its Changes: the keys Seed understands, the three schema-binding keys, and any custom keys a typed document adds.
Schema definitionThe schema this document defines, for other documents to use.
Extends
| name The document or space title. | optional | ||||
| summary A short description shown in previews and cards. | optional | ||||
| icon A square document or space image, as an `ipfs://` URL. | optional | ||||
| thumbnail Deprecated image field kept for old documents; use `icon` or `cover`. | optional | ||||
| cover A wide cover image shown in headers and cards, as an `ipfs://` URL. | optional | ||||
| siteUrl The web address a space is published at; set on the home document when a site is registered. | optional | ||||
| agentServerUrl The agents server this space advertises to its readers (an http(s) origin); clients connect to it beside their own servers. | optional | ||||
| spaceAgents Agents this space publishes to its readers: `{[agentId]: order}`, each id an agent on `agentServerUrl`; a removed agent leaves a null behind. | ⟨ * : ⟩ | optional | |||
| attributesSchema The attributes schema THIS document conforms to: the hm:// URL of a schema document (or ipfs://<cid> of a schema blob) whose struct describes the document's attributes. | optional | ||||
| childAttributesSchema The attributes schema this document's direct CHILDREN conform to (hm:// URL or ipfs://<cid>). A child may declare its own `attributesSchema` instead. | optional | ||||
| schemaDefinition This document DEFINES a schema: ipfs://<cid> of the schema blob it describes. Its target is the meta-schema, so an editor creates and validates the blob as a Hypermedia schema (the struct form, rooted at Struct by default). Other documents reference this document's URL as their `attributesSchema`/`childAttributesSchema`. | optional | ||||
| layout Legacy space header layout: `Seed/Experimental/Newspaper` or empty. | one of Seed/Experimental/Newspaper | | optional | |||
| seedExperimentalLogo Space header logo image. | optional | ||||
| seedExperimentalHomeOrder Legacy ordering of a space home listing. | one of UpdatedFirst | CreatedFirst | optional | |||
| displayPublishTime Publication date shown to readers when it differs from the change history. | optional | ||||
| displayAuthor Author byline shown to readers. | optional | ||||
| showOutline Whether to show the document outline. | optional | ||||
| showActivity Whether to show the document's activity and tools. | optional | ||||
| contentWidth Width of the content column: `S`, `M` or `L`. | one of S | M | L | optional | |||
| childrenType Layout of the document's root-level blocks, a block children type. | optional | ||||
| theme Visual settings for a space. | optional | ||||
| |||||
| importCategories Comma-separated categories kept from an external import (e.g. WordPress). | optional | ||||
| importTags Comma-separated tags kept from an external import (e.g. WordPress). | optional | ||||
Powered by Seed HypermediaOpen App