mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 08:38:32 +02:00
5b029e6117
* Applying doc changes based on reviews of past several documentation PRs
* Update docs
Clean up encryption docs
Clean up security docs
Delete export.md
Make new formats.md and add to sidebar. Also add all of the built-in formats, and examples for each.
Update mkdocs config for new files
* Fix broken docs links
* Correct incomplete sentences and markdown formatting issues
* Make overview a little more concise
* Update some command line arguments to latest version and make it a bit more concise
* Clean up unneeded TOML modifications and other scaffolding not needed for 3.9
* Revert "Clean up unneeded TOML modifications and other scaffolding not needed for 3.9"
This reverts commit 13b4266ed1.
* Specify that brew is also the easiest way to install jrnl on Linux
* Update docs/security.md
* Update docs/recipes.md
* 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
Co-authored-by: Jonathan Wren <jonathan@nowandwren.com>
59 lines
2.2 KiB
Markdown
59 lines
2.2 KiB
Markdown
# Overview
|
|
|
|
`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
|
|
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.
|
|
|
|
## Plain Text
|
|
|
|
`jrnl` stores each journal in plain text. You can store `jrnl` files anywhere,
|
|
including in shared folders to keep them synchronized between devices. Journal
|
|
files are compact (thousands of entries take up less than 1 MiB) and can be read
|
|
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 `@`). You can find and filter entries by using tags
|
|
along with other search criteria.
|
|
|
|
## Support for Multiple Journals
|
|
|
|
`jrnl` includes support for the creation of multiple journals, each of which
|
|
can be stored as a single file or as a set of files. Entries are automatically
|
|
timestamped in a human-readable format that makes it easy to view multiple
|
|
entries at a time. `jrnl` can easily find the entries you want so that you can
|
|
read them or edit them.
|
|
|
|
## Support for External Editors
|
|
|
|
`jrnl` plays nicely with your favorite text editor. You may prefer to write
|
|
journal entries in an editor. Or you may want to make changes that require a
|
|
more comprehensive application. `jrnl` can filter specific entries and pass them
|
|
to the external editor of your choice.
|
|
|
|
## Encryption
|
|
|
|
`jrnl` includes support for [AES
|
|
encryption](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard). See the
|
|
[encryption page](./encryption.md) for more information.
|
|
|
|
## Import and Export
|
|
|
|
`jrnl` makes it easy to import entries from other sources. Existing entries can
|
|
be exported in a variety of [formats](./formats.md).
|
|
|
|
## Multi-Platform Support
|
|
|
|
`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.
|
|
|
|
## Open-Source
|
|
|
|
`jrnl` is written in [Python](https://www.python.org) and maintained by a
|
|
[friendly community](https://github.com/jrnl-org/jrnl) of open-source software
|
|
enthusiasts.
|