Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/COMMANDS.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,14 +338,19 @@ notebook as a Markdown document instead of a JSON cells array. These call
`/api/v2`; the path and response contract may still change.

- `get --markdown` — print the notebook as Markdown (YAML frontmatter + body)
- `create --markdown --file doc.md` — create from a Markdown file; prints the new id
- `create --markdown --file doc.md` — create from a Markdown file; prints the new id.
Optional `--name` sets the notebook name (YAML frontmatter `title`, the Markdown
form of `data.attributes.name`). Without `--name`, the first ATX heading
(`#`–`######`, any level; setext headings are ignored) is used. If there is no
heading either, the name is left empty.
- `update --markdown --file doc.md` — replace the whole document
- `edit --markdown --file fragment.md` — append the fragment server-side

`create --markdown` prints the id rather than the document, so it composes:

```bash
ID=$(pup notebooks create --markdown --file doc.md)
# or: pup notebooks create --markdown --file doc.md --name "Weekly review"
pup notebooks get "$ID" --markdown
```

Expand Down
Loading
Loading