Note kit command

section.read

Read a section

Answers the Markdown of one section (the heading and everything under it), picked by heading path or line, with its range and first line; `withHeading: false` leaves the heading line out.

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

Parameters

Parameters of section.read
NameTypeRequiredDescription
headingstring[]noThe heading's path from the top, each element a heading's plain text, for example ["Plan", "Risks"]; or give line.
lineintegernoThe heading's line, from 1, instead of heading.
sectionstringnoThe section's id from outline.read ("section:3"), instead of heading or line: it names the same section after a rename or a move, for as long as the note stays open.
unit"scalar" | "utf16"noHow positions are counted: Unicode characters (scalar, the default), or UTF-16 code units as the editor counts them.
withHeadingbooleannoInclude the heading line.

Call through note_run

text
note_run {
  "path": "<file>.md",
  "steps": [{ "command": "section.read" }]
}

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

Result

Result of section.read
NameTypeRequiredDescription
fromintegeryesWhere it starts, in the request's unit.
lineintegeryesIts first line, from 1.
markdownstringyesThe Markdown, as the file has it.
tointegeryesWhere it ends (exclusive).
Result JSON Schema
json
{
  "additionalProperties": false,
  "properties": {
    "from": {
      "description": "Where it starts, in the request's unit.",
      "type": "integer"
    },
    "line": {
      "description": "Its first line, from 1.",
      "type": "integer"
    },
    "markdown": {
      "description": "The Markdown, as the file has it.",
      "type": "string"
    },
    "to": {
      "description": "Where it ends (exclusive).",
      "type": "integer"
    }
  },
  "required": [
    "from",
    "line",
    "markdown",
    "to"
  ],
  "type": "object"
}

Parameter schema

json
{
  "additionalProperties": false,
  "properties": {
    "heading": {
      "description": "The heading's path from the top, each element a heading's plain text, for example [\"Plan\", \"Risks\"]; or give line.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "line": {
      "description": "The heading's line, from 1, instead of heading.",
      "type": "integer"
    },
    "section": {
      "description": "The section's id from outline.read (\"section:3\"), instead of heading or line: it names the same section after a rename or a move, for as long as the note stays open.",
      "type": "string"
    },
    "unit": {
      "default": "scalar",
      "description": "How positions are counted: Unicode characters (scalar, the default), or UTF-16 code units as the editor counts them.",
      "enum": [
        "scalar",
        "utf16"
      ],
      "type": "string"
    },
    "withHeading": {
      "default": true,
      "description": "Include the heading line.",
      "type": "boolean"
    }
  },
  "type": "object"
}

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