Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to include time and title in arguments with --edit #1657

Merged
merged 1 commit into from
Jan 7, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions docs/external-editors.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,31 @@ License: https://www.gnu.org/licenses/gpl-3.0.html
# External editors

Configure your preferred external editor by updating the `editor` option
in your [configuration file](./reference-config-file.md#editor)
in your [configuration file](./reference-config-file.md#editor). If your editor is not
in your operating system's `PATH` environment variable, then you will have to
enter the full path of your editor.

If your editor is not in your operating system's `PATH` environment variable,
then you will have to enter in the full path of your editor.
Once it's configured, you can create an entry as a new document in your editor using the `jrnl`
command by itself:

``` text
jrnl
```

You can specify the time and title of the entry as usual on the first line of the document.

If you want, you can skip the editor by including a quick entry with the `jrnl` command:

``` text
jrnl yesterday: All my troubles seemed so far away.
```

If you want to start the entry on the command line and continue writing in your chosen editor,
use the `--edit` flag. For example:

``` text
jrnl yesterday: All my troubles seemed so far away. --edit
```

!!! note
To save and log any entry edits, save and close the file.
Expand Down Expand Up @@ -99,4 +120,4 @@ When you're done editing the message, save and `C-x #` to close the buffer and s

## Other editors

If you're using another editor and would like to share, feel free to [contribute documentation](./contributing.md#editing-documentation) on it.
If you're using another editor and would like to share, feel free to [contribute documentation](./contributing.md#editing-documentation) on it.