diff --git a/lua/neorg/modules/core/journal/module.lua b/lua/neorg/modules/core/journal/module.lua index 4f151fe85..4fb206c59 100644 --- a/lua/neorg/modules/core/journal/module.lua +++ b/lua/neorg/modules/core/journal/module.lua @@ -4,87 +4,132 @@ description: The journal module allows you to take personal notes with zero friction. summary: Easily track a journal within Neorg. --- -The journal module exposes a total of six commands. -The first three, `:Neorg journal today|yesterday|tomorrow`, allow you to access entries -for a given time relative to today. A file will be opened with the respective date as a `.norg` file. - -The fourth command, `:Neorg journal custom`, allows you to specify a custom date as an argument. -The date must be formatted according to the `YYYY-mm-dd` format, e.g. `2023-01-01`. - -The `:Neorg journal template` command creates a template file which will be used as the base whenever -a new journal entry is created. - -Last but not least, the `:Neorg journal toc open|update` commands open or create/update a Table of Contents -file found in the root of the journal. This file contains links to all other journal entries, alongside -their titles. +Journals are "periodic" in Neorg. You could have a daily journal, a weekly journal, a quarterly +journal, etc, (or all of them at once). Neorg ships with `daily`, `weekly`, and `monthly` journals +already defined, and `daily` is the default. + +### Commands: + +The main commands are: `:Neorg journal previous|current|next `, where `` is the name of +a periodic journal--either one of the pre-defined journal names mentioned above, or a custom name +added in configuration. Eliding `name` will use the default journal (usually `daily` but this is +configurable) + +Additionally, you can specify a custom date with `:Neorg journal custom `. The date +can be either: +- a date in `YYYY-mm-dd` format, e.g. `2023-01-01` +- a date in the Norg date format: `?,? -?