at.markpub.facets.baseBlocks

markpub.at

Documentation

main object

No description available.

Properties

index ref #byteSlice Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "index",
    "features"
  ],
  "properties": {
    "index": {
      "ref": "#byteSlice",
      "type": "ref"
    },
    "features": {
      "type": "array",
      "items": {
        "refs": [
          "#horizontalRule",
          "#yamlFrontMatter",
          "#raw"
        ],
        "type": "union"
      }
    }
  }
}
byteSlice object

Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets. Byte slices can overlap.

Properties

byteEnd integer Required

No description available.

minimum: 0
byteStart integer Required

No description available.

minimum: 0
View raw schema
{
  "type": "object",
  "required": [
    "byteStart",
    "byteEnd"
  ],
  "properties": {
    "byteEnd": {
      "type": "integer",
      "minimum": 0
    },
    "byteStart": {
      "type": "integer",
      "minimum": 0
    }
  },
  "description": "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets. Byte slices can overlap."
}
horizontalRule object

Place an `<hr>` element at the provided byte index.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Place an `<hr>` element at the provided byte index."
}
raw object

Place raw text at the provided byte index. This is a powerful escape hatch for anything that can't be achieved with the other facet features, but use it with caution as it can easily break things if used incorrectly. Do not expect systems to render it.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Place raw text at the provided byte index. This is a powerful escape hatch for anything that can't be achieved with the other facet features, but use it with caution as it can easily break things if used incorrectly. Do not expect systems to render it."
}
yamlFrontMatter object

Identify a block of front matter at the top of the Markdown block. It is expected that this has a byteStart and byteEnd.

This object has no properties defined.

View raw schema
{
  "type": "object",
  "properties": {},
  "description": "Identify a block of front matter at the top of the Markdown block. It is expected that this has a byteStart and byteEnd."
}

Lexicon Garden

@