# site.standard.document

> 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.document)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uqzpqmrjnptsxezjx4xuh2mn/site.standard.document/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uqzpqmrjnptsxezjx4xuh2mn/site.standard.document/examples)

## Definitions

### `site.standard.document`

**Type**: `record`

A document record representing a published article, blog post, or other content. Documents can belong to a publication or exist independently.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `path` | `string` | No | Combine with site URL to construct a canonical URL to the document. |
| `site` | `string` (uri) | Yes | Points to a publication record (at://) or a publication url (https://) for loose documents. |
| `tags` | `array` | No | Array of strings used to tag or categorize the document. |
| `title` | `string` | Yes | Title of the document. |
| `content` | `union` | No | Open union used to define the record's content. Each entry must specify a $type. |
| `updatedAt` | `string` (datetime) | No | Timestamp of the document's last edit. |
| `coverImage` | `blob` | No | Cover image. Less than 1MB. |
| `bskyPostRef` | `ref` → `com.atproto.repo.strongRef` | No | Strong reference to a Bluesky post. |
| `description` | `string` | No | A brief description or excerpt from the document. |
| `publishedAt` | `string` (datetime) | Yes | Timestamp of the document's publish time. |
| `textContent` | `string` | No | Plaintext representation of the document's contents. Should not contain markdown or other formatting. |

## Raw Schema

```json
{
  "id": "site.standard.document",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "site",
          "title",
          "publishedAt"
        ],
        "properties": {
          "path": {
            "type": "string",
            "description": "Combine with site URL to construct a canonical URL to the document."
          },
          "site": {
            "type": "string",
            "format": "uri",
            "description": "Points to a publication record (at://) or a publication url (https://) for loose documents."
          },
          "tags": {
            "type": "array",
            "items": {
              "type": "string",
              "maxLength": 1280,
              "maxGraphemes": 128
            },
            "description": "Array of strings used to tag or categorize the document."
          },
          "title": {
            "type": "string",
            "maxLength": 5000,
            "description": "Title of the document.",
            "maxGraphemes": 500
          },
          "content": {
            "refs": [],
            "type": "union",
            "closed": false,
            "description": "Open union used to define the record's content. Each entry must specify a $type."
          },
          "updatedAt": {
            "type": "string",
            "format": "datetime",
            "description": "Timestamp of the document's last edit."
          },
          "coverImage": {
            "type": "blob",
            "accept": [
              "image/*"
            ],
            "maxSize": 1000000,
            "description": "Cover image. Less than 1MB."
          },
          "bskyPostRef": {
            "ref": "com.atproto.repo.strongRef",
            "type": "ref",
            "description": "Strong reference to a Bluesky post."
          },
          "description": {
            "type": "string",
            "maxLength": 30000,
            "description": "A brief description or excerpt from the document.",
            "maxGraphemes": 3000
          },
          "publishedAt": {
            "type": "string",
            "format": "datetime",
            "description": "Timestamp of the document's publish time."
          },
          "textContent": {
            "type": "string",
            "description": "Plaintext representation of the document's contents. Should not contain markdown or other formatting."
          }
        }
      },
      "description": "A document record representing a published article, blog post, or other content. Documents can belong to a publication or exist independently."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```