# site.standard.publication

> Published by [syui.ai](https://lexicon.garden/identity/did:plc:uqzpqmrjnptsxezjx4xuh2mn)

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:uqzpqmrjnptsxezjx4xuh2mn/site.standard.publication)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uqzpqmrjnptsxezjx4xuh2mn/site.standard.publication/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uqzpqmrjnptsxezjx4xuh2mn/site.standard.publication/examples)

## Definitions

### `site.standard.publication`

**Type**: `record`

A publication record representing a blog, website, or content platform. Publications serve as containers for documents and define the overall branding and settings.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `url` | `string` (uri) | Yes | Base publication url (ex: https://syui.ai). The canonical document URL is formed by combining this value with the document path. |
| `icon` | `blob` | No | Square image to identify the publication. Should be at least 256x256. |
| `name` | `string` | Yes | Name of the publication. |
| `basicTheme` | `ref` → `site.standard.theme.basic` | No | Simplified publication theme for tools and apps to utilize when displaying content. |
| `description` | `string` | No | Brief description of the publication. |
| `preferences` | `ref` → `#preferences` | No | Object containing platform specific preferences. |

### `site.standard.publication#preferences`

**Type**: `object`

Platform-specific preferences for the publication, including discovery and visibility settings.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `showInDiscover` | `boolean` | No | Boolean which decides whether the publication should appear in discovery feeds. |

## Raw Schema

```json
{
  "id": "site.standard.publication",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "url",
          "name"
        ],
        "properties": {
          "url": {
            "type": "string",
            "format": "uri",
            "description": "Base publication url (ex: https://syui.ai). The canonical document URL is formed by combining this value with the document path."
          },
          "icon": {
            "type": "blob",
            "accept": [
              "image/*"
            ],
            "maxSize": 1000000,
            "description": "Square image to identify the publication. Should be at least 256x256."
          },
          "name": {
            "type": "string",
            "maxLength": 5000,
            "description": "Name of the publication.",
            "maxGraphemes": 500
          },
          "basicTheme": {
            "ref": "site.standard.theme.basic",
            "type": "ref",
            "description": "Simplified publication theme for tools and apps to utilize when displaying content."
          },
          "description": {
            "type": "string",
            "maxLength": 30000,
            "description": "Brief description of the publication.",
            "maxGraphemes": 3000
          },
          "preferences": {
            "ref": "#preferences",
            "type": "ref",
            "description": "Object containing platform specific preferences."
          }
        }
      },
      "description": "A publication record representing a blog, website, or content platform. Publications serve as containers for documents and define the overall branding and settings."
    },
    "preferences": {
      "type": "object",
      "properties": {
        "showInDiscover": {
          "type": "boolean",
          "default": true,
          "description": "Boolean which decides whether the publication should appear in discovery feeds."
        }
      },
      "description": "Platform-specific preferences for the publication, including discovery and visibility settings."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```