fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-05-10 00:28:31 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update YAML export description in docs (#1591)

Browse source
This commit is contained in:
Kevin 2022-09-10 11:48:20 -07:00 • committed by GitHub
parent 405e0c2199
commit b5a22379b8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/formats.md
View file

@ -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
|- ...
```