Publication Lexicon

The site.standard.publication lexicon is used to describe information about a particular publication.

Overview

A publication represents a collection of documents published to the web. It includes important information about a publication including its location on the web, theming information, user preferences, and more.

The publication lexicon is not a requirement, but is recommended when publishing collections of related documents.

Schema

Required Properties

Property	Type	Description
url	string	Base url for the publication. (ex: https://standard.site). This value will be combined with the document path to construct a full URL for the document. Avoid trailing slashes.
name	string	Name of the publication. `maxLength: 5000` `maxGraphemes: 500`

Optional Properties

Property	Type	Description
icon	blob	Square image to identify the publication. Should be at least 256x256.
description	string	Brief description of the publication. `maxLength: 30000` `maxGraphemes: 3000`
basicTheme	ref	Simplified theme for tools and apps to utilize when displaying content. (ref → site.standard.theme.basic)
preferences	object	Platform-specific preferences for the publication, including discovery and visibility settings.
preferences.showInDiscover	boolean	Decides whether the publication should appear in discovery feeds.

Example

{
  "$type": "site.standard.publication",
  "url": "https://standard.site",
  "icon": {
    "$type": "blob",
    "ref": {
      "$link": "bafkreiexample123456789"
    },
    "mimeType": "image/png",
    "size": 12345
  },
  "name": "Standard.site Blog",
  "description": "Documentation and updates about Standard.site lexicons",
  "basicTheme": {
    "$type": "site.standard.theme.basic",
    "background": {
      "$type": "site.standard.theme.color#rgb",
      "r": 255,
      "g": 255,
      "b": 255
    },
    "foreground": {
      "$type": "site.standard.theme.color#rgb",
      "r": 31,
      "g": 41,
      "b": 55
    },
    "accent": {
      "$type": "site.standard.theme.color#rgb",
      "r": 59,
      "g": 130,
      "b": 246
    },
    "accentForeground": {
      "$type": "site.standard.theme.color#rgb",
      "r": 255,
      "g": 255,
      "b": 255
    }
  },
  "preferences": {
    "showInDiscover": true
  }
}

View the Lexicon

Extensibility

Lexicons are extendable. Additional properties may be added to better suit the needs of a project.

Best Practices

While we encourage avoid trailing slashes, some may not implement this in practice. If you are validating records, you should trim trailing slashes for url in your codebase.

Document lexicon - Individual documents within publications
Theme lexicon - Publication theming
Verification - Link publications to a domain
Quick Start - Implementation guide