---
title: "table.format: Format a table — Note kit command — Kition"
description: "Rewrites a table with padded cells so its columns line up in the Markdown source, keeping every cell's text."
canonical: "https://developer.kition.ai/docs/kits/note/commands/table.format"
---

> Canonical HTML: [https://developer.kition.ai/docs/kits/note/commands/table.format](https://developer.kition.ai/docs/kits/note/commands/table.format)

# 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)); reference: [Note kit commands](https://developer.kition.ai/docs/kits/note.md)
- Changes the document: yes

## Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `table` | `integer` | yes | The 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

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `changed` | `boolean` | yes | Whether the note's text changed (false when it already read so). |

```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).
