Document

A Document is the base of organizing knowledge. It is comparable to a single PDF or web page. A document describes what may appear within a single window at one time.

Content

The Document Content contains the full message that the authors are intending to share. It is saved inside the content field.

Attributes

A Document contains the following Attributes which are used to describe the Document, as well as some presentation preferences:

Name

Icon

Width

Navigation

Every Document has a Document Navigation. By default, the Navigation will be the Navigation View of the Document Content. (Previously known as the outline).

The Document may have a navigation field defined, which will override the Content that is used to generate the Navigation. This allows authors to control how readers will go deeper into the content, and will probably contain Cards and Queries that expose Sub-Documents.

A Document Navigation can include an embed of the document itself, which allows an "outline" to appear in the Navigation UI, helping the reader jump around headings inside the document.

Theme

Values from the theme field are special because they affect the syle of Sub-Documents in addition to the document itself.

The Seed app will probably only allow theme customization from the Site Home, but the protocol theoretically supports the Theme on any document.

"theme": {
  "colors": {},
}

Example Snapshot

{
  "name": "My Document",
  "icon": "ipfs://1234",
  "content": BlockNode[]
  "navigation": BlockNode[],
  "theme":  {...}
  ...attributes
}

Activity