mirror of
https://github.com/mickael-menu/zk
synced 2024-11-13 01:10:43 +00:00
25 lines
1.5 KiB
Markdown
25 lines
1.5 KiB
Markdown
|
# Creating a new note
|
||
|
|
|
||
|
|
You can add a new note to a [notebook](notebook.md) using `zk new --title "An interesting concept" [<directory>]`.
|
||
|
|
|
||
|
|
`zk` automatically generates a filename and initial content according to rules set in your [configuration file](config.md). These settings can be customized per [group of notes](config-group.md) in your notebook, as illustrated in [Maintaining a daily journal](daily-journal.md).
|
||
|
|
|
||
|
|
By default, `zk new` will start [your editor](tool-editor.md) after creating the note. You can choose instead to print the absolute path to the note with `--print-path`, which is more useful for [automation](automation.md).
|
||
|
|
|
||
|
|
## Search or create with a single command
|
||
|
|
|
||
|
|
If you are not sure whether a note already exists for a particular subject, the "search or create" mode might be more appropriate than `zk new`. It is inspired by [Notational Velocity](https://notational.net/) and enables searching for an existing note or creating a new one in a single action.
|
||
|
|
|
||
|
|
This option is available when running `zk edit --interactive`, which spawns [`fzf`](tool-fzf.md) to filter selected notes. From `fzf`, press `Ctrl-N` to create a new note using the current search query as title.
|
||
|
|
|
||
|
|
## Create a note with initial content
|
||
|
|
|
||
|
|
Initial content can be fed to the template through a standard input pipe, which will be expandable with the `{{content}}` [template variable](template-creation.md).
|
||
|
|
|
||
|
|
For example, to use the content of the macOS clipboard as the initial content you can run:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
$ pbpaste | zk new
|
||
|
|
```
|
||
|
|
|