Note kit command

note.write

Write the whole note

Replaces the whole note with `markdown` as one undo step, rewriting only the lines that differ. Use it to write a new note; prefer section, block and text commands to change part of one.

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

Parameters

Parameters of note.write
NameTypeRequiredDescription
markdownstringyesThe note's whole new Markdown; only the lines that differ are changed.

Call through note_run

text
note_run {
  "path": "<file>.md",
  "steps": [{ "command": "note.write", "params": { "markdown": <string> } }]
}

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 note.write
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": {
    "markdown": {
      "description": "The note's whole new Markdown; only the lines that differ are changed.",
      "type": "string"
    }
  },
  "required": [
    "markdown"
  ],
  "type": "object"
}

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