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

Clean up config file doc for readability

Browse source
This commit is contained in:
Micah Jerome Ellison 2021-09-18 15:00:16 -07:00
parent 5b5c90d226
commit 6179c321bc
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/reference-config-file.md
View file

@ -1,6 +1,6 @@
# Configuration File Reference # Configuration File Reference
You can configure the way `jrnl` behaves in a configuration file. You can configure `jrnl` with a configuration file.
!!! note !!! note
Backup your journal and config file before editing. Changes to the config file Backup your journal and config file before editing. Changes to the config file
@ -15,6 +15,8 @@ file will be saved as `$XDG_CONFIG_HOME/jrnl/jrnl.yaml`.
On Windows, the configuration file is typically found at On Windows, the configuration file is typically found at
`%USERPROFILE%\.config\jrnl\jrnl.yaml`. `%USERPROFILE%\.config\jrnl\jrnl.yaml`.
You can also find your configuration file location by running:
`jrnl --list`
## Format ## Format
The configuration file is a [YAML](https://yaml.org/) file and can be edited with The configuration file is a [YAML](https://yaml.org/) file and can be edited with
@ -69,11 +71,11 @@ Symbols to be interpreted as tags.
entries. entries.
### default_hour and default_minute ### default_hour and default_minute
If you supply a date, such as `last thursday`, but no specific time, Entries will be created at this time if you supply a date but no specific time (for example, `last thursday`).
the entry will be created at this time.
### timeformat ### timeformat
How to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference. Defines how to format the timestamps as they are stored in your journal.
See the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference.
Do not change this for an existing journal, since that might lead Do not change this for an existing journal, since that might lead
to data loss. to data loss.