From b5a22379b8bee955fa2b4e8d2d7904bcc6c53fba Mon Sep 17 00:00:00 2001 From: Kevin Date: Sat, 10 Sep 2022 11:48:20 -0700 Subject: [PATCH] Update YAML export description in docs (#1591) --- docs/formats.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/formats.md b/docs/formats.md index 47904c1e..c557f9dc 100644 --- a/docs/formats.md +++ b/docs/formats.md @@ -271,13 +271,14 @@ supported by many programs and programming languages. ### YAML ``` sh -jrnl --format yaml +jrnl --format yaml --file 'my_directory/' ``` This outputs your journal into YAML format. YAML is a commonly used data format and is -supported by many programs and programming languages. +supported by many programs and programming languages. [Exporting to directories](#exporting-to-directories) is the +only supported YAML export option and each entry will be written to a separate file. -**Example output**: +**Example file**: ``` yaml title: This is the second sample entry date: 2020-07-01 20:00 @@ -335,14 +336,14 @@ jrnl --format json > myjournal.json If the `--file` argument is a directory, jrnl will export each entry into an individual file: ``` sh -jrnl --format json --file my_entries/ +jrnl --format yaml --file my_entries/ ``` The contents of `my_entries/` will then look like this: ``` output my_entries/ -|- 2013_06_03_a-beautiful-day.json -|- 2013_06_07_dinner-with-gabriel.json +|- 2013_06_03_a-beautiful-day.yaml +|- 2013_06_07_dinner-with-gabriel.yaml |- ... ```