Collect your thoughts and notes without leaving the command line.
Find a file
Jonathan Wren 558d331d66
Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105)
* add some attribtutes to docs template for accessbility

* fix colors to meet accessibility guidelines (4.5 contrast ratio for text)

* Fix last remaining pa11y error (no button on search form)

This fix required moving the mkdocs theme out of the docs directory.
It's no in the docs_theme directory, and the mkdocs config is updated
accordingly.

* Re-enable accessibility testing for docs sit

Also, move the pa11y script into the gh actions workflow

* clean up linting issues in css

* fix and standardize link colors across site

* fix twitter button opacity making text fail contrast requirements

* move buttons on docs site index nav, tweak font weights

* fix footer opacity, tweak spacing of the now more visible sections of the page

* change font sizes on index page to meet WCAG

* udpate font sizes site-wide for accessibility

* fix sidebar for accessibility (font sizes and color contrasts)

* restyle code blocks to have dark background, and meet accessibility requirements

* standardize (accessible) colors across docs site
2020-12-12 12:05:12 -08:00
.build Add changelog generation workflow to github actions (#1086) 2020-11-21 11:21:19 -08:00
.github Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105) 2020-12-12 12:05:12 -08:00
docs Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105) 2020-12-12 12:05:12 -08:00
docs_theme Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105) 2020-12-12 12:05:12 -08:00
features Fix Unicode encoding failure in directory export when creating filenames from journal titles with certain characters (#1090) 2020-11-21 15:41:08 -08:00
jrnl Check for readline module instead of Windows when initializing autocomplete in install (#1104) 2020-12-04 15:13:38 -08:00
tests Check for readline module instead of Windows when initializing autocomplete in install (#1104) 2020-12-04 15:13:38 -08:00
.gitattributes Ensure test data is always checked out with LF line endings (#965) 2020-05-27 14:08:48 -07:00
.gitignore Add extended metadata support for DayOne Classic (#928) 2020-06-06 12:41:15 -07:00
CHANGELOG.md Update changelog [ci skip] 2020-12-04 23:15:30 +00:00
CODE_OF_CONDUCT.md Update the code of conduct (#913) 2020-04-18 12:35:46 -07:00
CONTRIBUTING.md Correct typos in CONTRIBUTING.md (#1040) 2020-09-05 10:53:10 -07:00
issue_template.md Clean up templates and issues (#954) 2020-05-23 15:58:04 -07:00
LICENSE.md Upgrade license to GPLv3 (#918) 2020-04-18 13:31:25 -07:00
Makefile Make behave output more concise when running make test (#988) 2020-06-27 17:51:31 -07:00
mkdocs.yml Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105) 2020-12-12 12:05:12 -08:00
poetry.lock Update dependencies - pyxdg, pytest, black (#1076) 2020-11-14 12:42:34 -08:00
pyproject.toml Increment version to v2.5.1-alpha 2020-11-28 22:49:08 +00:00
README.md Update build badge in readme to point at github instead of travis (#1094) 2020-11-25 12:33:38 -08:00
readthedocs.yml Make docs site (jrnl.sh) fully meet Web Content Accessibility Guidelines (WCAG) 2.1 (#1105) 2020-12-12 12:05:12 -08:00

jrnl Testing Downloads Version

To get help, submit an issue on Github.

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.

In a Nutshell

To make a new entry, just enter

jrnl yesterday: Called in sick. Used the time to clean the house and write my
book.

yesterday: is interpreted by jrnl as a timestamp. Everything until the first sentence ending (either ., ?, or !) is interpreted as the title, and the rest as the body. In your journal file, the result will look like this:

[2012-03-29 09:00] Called in sick.
Used the time to clean the house and write my book.

If you just call jrnl, you will be prompted to compose your entry - but you can also configure jrnl to use your external editor.

For more information, please read the documentation.

Contributors

Maintainers

Our maintainers help keep the lights on for the project:

Please thank them if you like jrnl!

Code Contributors

This project is made with love by the many fabulous people who have contributed. jrnl couldn't exist without each and every one of you!

If you'd also like to help make jrnl better, please see our contributing documentation.

Financial Backers

Another way show support is through direct financial contributions. These funds go to covering our costs, and are a quick way to show your appreciation for jrnl.

Become a financial contributor and help us sustain our community.