Correct incomplete sentences and markdown formatting issues

This commit is contained in:
Micah Jerome Ellison 2020-09-05 15:00:53 -07:00
parent e28cf1d296
commit bc7a2cb8ef
4 changed files with 11 additions and 10 deletions

View file

@ -74,7 +74,7 @@ decrypt your journal.
will still be recoverable even if `jrnl` isn't around anymore. Please use
`jrnl --decrypt` if available.
**Example 1** (for jrnl v2 files):
**Example for jrnl v2 files**:
``` python
#!/usr/bin/env python3
"""
@ -113,7 +113,7 @@ key = base64.urlsafe_b64encode(kdf.derive(password))
print(Fernet(key).decrypt(ciphertext).decode('utf-8'))
```
**Example 1** (for jrnl v1 files):
**Example for jrnl v1 files**:
``` python
#!/usr/bin/env python3
"""

View file

@ -18,7 +18,7 @@ directory, jrnl will export each entry into an individual file
jrnl --format json -o my_entries/
```
The contents of `my\_entries/` will then look like this:
The contents of `my_entries/` will then look like this:
``` output
my_entries/

View file

@ -3,7 +3,7 @@
`jrnl` is a simple journal application for the command line.
You can use it to easily create, search, and view journal entries. Journals are
stored as human-readable plain text, and can also be encrypted using [AES
stored as human-readable plain text, and can also be encrypted using [AES
encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
`jrnl` has most of the features you need, and few of the ones you don't.
@ -18,7 +18,8 @@ by almost any electronic device, now and for the foreseeable future.
## Tags
To make it easier to find entries later, `jrnl` includes support for inline tags
(the default tag symbol is `@`). Entries can be found and filtered
(the default tag symbol is `@`). Entries can be found and filtered using tags
along with other search criteria.
## Support for Multiple Journals
@ -48,9 +49,8 @@ be exported in a variety of [formats](./formats.md).
## Multi-Platform Support
`jrnl` is compatible with most operating systems. You can download it using one
`jrnl` is compatible with most operating systems. You can [download](./installation.md) it using one
of a variety of package managers, or you can build from source.
See the [installation page](./installation.md) for more information.
## Open-Source

View file

@ -83,9 +83,10 @@ _now_), the following options are equivalent:
- `jrnl *Best day of my life.`
- `jrnl Best day of my life.*`
!!! note Make sure that the asterisk (`*`) is **not** surrounded by whitespaces.
`jrnl Best day of my life! *` will not work because the `*` character has a
special meaning in most shells.
!!! note
Make sure that the asterisk (`*`) is **not** surrounded by whitespaces.
`jrnl Best day of my life! *` will not work because the `*` character has a
special meaning in most shells.
## Viewing Entries ##