Note kit command

table.format

Format a table

Rewrites a table with padded cells so its columns line up in the Markdown source, keeping every cell's text.

Kit
Note 0.3.0 (Markdown (.md))
Changes the document
yes

Parameters

Parameters of table.format
NameTypeRequiredDescription
tableintegeryesThe table's index in the note, from 0 (document order).

Call through note_run

text
note_run {
  "path": "<file>.md",
  "steps": [{ "command": "table.format", "params": { "table": <integer> } }]
}

The required parameters, with placeholders for their types: not a tested example. note_run answers the step’s result in completed[i].result.

Result

Result of table.format
NameTypeRequiredDescription
changedbooleanyesWhether the note's text changed (false when it already read so).
Result JSON Schema
json
{
  "additionalProperties": false,
  "properties": {
    "changed": {
      "description": "Whether the note's text changed (false when it already read so).",
      "type": "boolean"
    }
  },
  "required": [
    "changed"
  ],
  "type": "object"
}

Parameter schema

json
{
  "additionalProperties": false,
  "properties": {
    "table": {
      "description": "The table's index in the note, from 0 (document order).",
      "type": "integer"
    }
  },
  "required": [
    "table"
  ],
  "type": "object"
}

Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9). As data: commands.jsonl.