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

Add per-journal config documentation (#1199)

Browse source 
* update documentation with example config

* make format

* clarify meaning of config
This commit is contained in:
Suhas 2021-02-27 13:53:21 -05:00 • committed by GitHub
parent e6c0a16342
commit 67682e7e93
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/advanced.md
View file

@ -1,5 +1,6 @@
<!-- Copyright (C) 2012-2021 jrnl contributors <!-- Copyright (C) 2012-2021 jrnl contributors
License: https://www.gnu.org/licenses/gpl-3.0.html --> License: https://www.gnu.org/licenses/gpl-3.0.html -->
# Advanced Usage # Advanced Usage
## Configuration File ## Configuration File
@ -99,11 +100,31 @@ food: ~/my_recipes.txt
``` ```
Your `default` and your `food` journals won't be encrypted, however your Your `default` and your `food` journals won't be encrypted, however your
`work` journal will! You can override all options that are present at `work` journal will!
You can override all options that are present at
the top level of `jrnl.yaml`, just make sure that at the very least the top level of `jrnl.yaml`, just make sure that at the very least
you specify a `journal: ...` key that points to the journal file of you specify a `journal: ...` key that points to the journal file of
that journal. that journal.
Consider the following example configuration
```yaml
editor: vi -c startinsert
journals:
default: ~/journal.txt
work:
journal: ~/work.txt
encrypt: true
display_format: json
editor: code -rw
food:
display_format: markdown
journal: ~/recipes.txt
```
The `work` journal is encrypted, prints to `json` by default, and is edited using an existing window of VSCode. Similarly, the `food` journal prints to markdown by default, but uses all the other defaults.
!!! note !!! note
Changing `encrypt` to a different value will not encrypt or decrypt your Changing `encrypt` to a different value will not encrypt or decrypt your
journal file, it merely says whether or not your journal journal file, it merely says whether or not your journal