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

Fix markup in "Advanced Usage" doc (#1655)

Browse source 
* Fix YAML indentiation in a configuration example
* Improve Markdown markup
This commit is contained in:
Jonathan Ballet 2023-01-07 22:58:49 +01:00 • committed by GitHub
parent 2cec8bdc5b
commit 458faff8a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/advanced.md
View file

@ -20,8 +20,8 @@ for example:
``` yaml ``` yaml
journals: journals:
default: ~\journal.txt default: ~/journal.txt
work: ~\work.txt work: ~/work.txt
``` ```
The `default` journal gets created the first time you start `jrnl` The `default` journal gets created the first time you start `jrnl`
@ -42,11 +42,11 @@ If your `jrnl.yaml` looks like this:
``` yaml ``` yaml
encrypt: false encrypt: false
journals: journals:
default: ~/journal.txt default: ~/journal.txt
work: work:
journal: ~/work.txt journal: ~/work.txt
encrypt: true encrypt: true
food: ~/my_recipes.txt 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
@ -59,7 +59,7 @@ that journal.
Consider the following example configuration Consider the following example configuration
```yaml ``` yaml
editor: vi -c startinsert editor: vi -c startinsert
journals: journals:
default: ~/journal.txt default: ~/journal.txt
@ -80,22 +80,22 @@ The `work` journal is encrypted, prints to `json` by default, and is edited usin
You can override a configuration field for the current instance of `jrnl` using `--config-override CONFIG_KEY CONFIG_VALUE` where `CONFIG_KEY` is a valid configuration field, specified in dot notation and `CONFIG_VALUE` is the (valid) desired override value. The dot notation can be used to change config keys within other keys, such as `colors.title` for the `title` key within the `colors` key. You can override a configuration field for the current instance of `jrnl` using `--config-override CONFIG_KEY CONFIG_VALUE` where `CONFIG_KEY` is a valid configuration field, specified in dot notation and `CONFIG_VALUE` is the (valid) desired override value. The dot notation can be used to change config keys within other keys, such as `colors.title` for the `title` key within the `colors` key.
You can specify multiple overrides as multiple calls to `--config-override`. You can specify multiple overrides as multiple calls to `--config-override`.
!!! note !!! note
These overrides allow you to modify ***any*** field of your jrnl configuration. We trust that you know what you are doing. These overrides allow you to modify ***any*** field of your jrnl configuration. We trust that you know what you are doing.
#### Examples: #### Examples:
``` sh ``` sh
#Create an entry using the `stdin` prompt, for rapid logging # Create an entry using the `stdin` prompt, for rapid logging
jrnl --config-override editor "" jrnl --config-override editor ""
#Populate a project's log # Populate a project's log
jrnl --config-override journals.todo "$(git rev-parse --show-toplevel)/todo.txt" todo find my towel jrnl --config-override journals.todo "$(git rev-parse --show-toplevel)/todo.txt" todo find my towel
#Pass multiple overrides # Pass multiple overrides
jrnl --config-override display_format fancy --config-override linewrap 20 \ jrnl --config-override display_format fancy --config-override linewrap 20 \
--config-override colors.title green --config-override colors.title green
``` ```
### Using an alternate config ### Using an alternate config
@ -105,7 +105,7 @@ You can specify an alternate configuration file for the current instance of `jrn
#### Examples: #### Examples:
``` ``` sh
# Use personalised configuration file for personal journal entries # Use personalised configuration file for personal journal entries
jrnl --config-file ~/foo/jrnl/personal-config.yaml jrnl --config-file ~/foo/jrnl/personal-config.yaml