Doc updates:

- Remove import/export page, fold it into formats
- Rename security to privacy-and-security.md to avoid conflation w/ github security issues
- Various small cleanup and edits from PR review
This commit is contained in:
Micah Jerome Ellison 2020-10-24 15:23:36 -07:00
parent c6f7af44bd
commit 2d910459ae
6 changed files with 25 additions and 39 deletions

View file

@ -4,7 +4,7 @@
While `jrnl` follows best practices, total security is never possible in the While `jrnl` follows best practices, total security is never possible in the
real world. There are a number of ways that people can at least partially real world. There are a number of ways that people can at least partially
compromise your `jrnl` data. See the [Privacy and Security](./security.md) page compromise your `jrnl` data. See the [Privacy and Security](./privacy-and-security.md) page
for more information. for more information.
## Encrypting and Decrypting ## Encrypting and Decrypting
@ -35,7 +35,7 @@ encrypted file untouched and create a new plain text file next to it.
## Storing Passwords in Your Keychain ## Storing Passwords in Your Keychain
You can't recover or reset your `jrnl` password. If you lose it, Nobody can recover or reset your `jrnl` password. If you lose it,
your data will be inaccessible forever. your data will be inaccessible forever.
For this reason, when encrypting a journal, `jrnl` asks whether you would like For this reason, when encrypting a journal, `jrnl` asks whether you would like

View file

@ -223,8 +223,7 @@ journal on disk. This format is particularly useful for importing and exporting
within `jrnl`. within `jrnl`.
You can use it, for example, to move entries from one journal to another, or to create a You can use it, for example, to move entries from one journal to another, or to create a
new journal with search results from another journal (see [Import and new journal with search results from another journal.
Export](./import-and-export.md) for more details).
**Example output**: **Example output**:
``` sh ``` sh
@ -307,11 +306,11 @@ Example output:
## Options ## Options
### `--file` ### Exporting with `--file`
Example: `jrnl --format json --file /some/path/to/a/file.txt` Example: `jrnl --format json --file /some/path/to/a/file.txt`
By default, `jrnl` will output entries to your terminal. But if you provide the `--file` By default, `jrnl` will output entries to your terminal. But if you provide `--file`
along with a filename, the same output that would have been to your terminal will be along with a filename, the same output that would have been to your terminal will be
written to the file instead. This is the same as piping the output to a file. written to the file instead. This is the same as piping the output to a file.
@ -325,3 +324,19 @@ jrnl --format json --file myjournal.json
jrnl --format json > myjournal.json jrnl --format json > myjournal.json
``` ```
#### Exporting to directories
If the `--file` argument is a directory, jrnl will export each entry into an individual file:
``` sh
jrnl --format json --file my_entries/
```
The contents of `my_entries/` will then look like this:
``` output
my_entries/
|- 2013_06_03_a-beautiful-day.json
|- 2013_06_07_dinner-with-gabriel.json
|- ...
```

View file

@ -1,28 +0,0 @@
<!--
@TODO: Update this for v2.5
-->
## Export to files
You can specify the output file of your exported journal using the
`-o` argument
``` sh
jrnl --format md -o journal.md
```
The above command will generate a file named `journal.md`. If the`-o` argument is a
directory, jrnl will export each entry into an individual file
``` sh
jrnl --format json -o my_entries/
```
The contents of `my_entries/` will then look like this:
``` output
my_entries/
|- 2013_06_03_a-beautiful-day.json
|- 2013_06_07_dinner-with-gabriel.json
|- ...
```

View file

@ -2,14 +2,14 @@
## Installation ## Installation
On Mac and Linux, the easiest way to install *jrnl* is using On Mac and Linux, the easiest way to install `jrnl` is using
[Homebrew](http://brew.sh/): [Homebrew](http://brew.sh/):
``` sh ``` sh
brew install jrnl brew install jrnl
``` ```
On other platforms, install *jrnl* using [Python](https://www.python.org/) 3.6+ and [pipx](https://pipxproject.github.io/pipx/): On other platforms, install `jrnl` using [Python](https://www.python.org/) 3.6+ and [pipx](https://pipxproject.github.io/pipx/):
``` sh ``` sh
pipx install jrnl pipx install jrnl
@ -37,4 +37,4 @@ Used the time to clean the house and spent 4h on writing my book.
``` ```
If you just call `jrnl`, you will be prompted to compose your entry - If you just call `jrnl`, you will be prompted to compose your entry -
but you can also configure *jrnl* to use your external editor. but you can also [configure](advanced.md) *jrnl* to use your external editor.

View file

@ -18,8 +18,7 @@ nav:
- Quickstart: installation.md - Quickstart: installation.md
- Basic Usage: usage.md - Basic Usage: usage.md
- Encryption: encryption.md - Encryption: encryption.md
- Privacy and Security: security.md - Privacy and Security: privacy-and-security.md
- Formats: formats.md - Formats: formats.md
- Import and Export: import-and-export.md
- Advanced Usage: advanced.md - Advanced Usage: advanced.md
- Recipes: recipes.md - Recipes: recipes.md