Note kit command
section.replace
Replace a section
Replaces the body of the section at a heading path or line (subsections included) with `markdown`, keeping its heading unless `withHeading: true` (then `markdown` includes the heading).
- Kit
- Note 0.3.0 (Markdown (.md))
- Changes the document
- yes
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
heading | string[] | no | The heading's path from the top, each element a heading's plain text, for example ["Plan", "Risks"]; or give line. |
line | integer | no | The heading's line, from 1, instead of heading. |
markdown | string | yes | The section's new Markdown. |
section | string | no | 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. |
withHeading | boolean | no | Replace the heading line too. |
Call through note_run
text
note_run {
"path": "<file>.md",
"steps": [{ "command": "section.replace", "params": { "markdown": <string> } }]
}The required parameters, with placeholders for their types: not a tested example. Optional: heading, line, section, withHeading. 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). |
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": {
"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"
},
"markdown": {
"description": "The section's new Markdown.",
"type": "string"
},
"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"
},
"withHeading": {
"default": false,
"description": "Replace the heading line too.",
"type": "boolean"
}
},
"required": [
"markdown"
],
"type": "object"
}Generated from kition-sdk packages/script/kits/note.ts and the kit itself (kition-note@69e14d9). As data: commands.jsonl.