mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
558d331d66
* 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
40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
# Getting started
|
|
|
|
## Installation
|
|
|
|
On Mac and Linux, the easiest way to install `jrnl` is using
|
|
[Homebrew](http://brew.sh/):
|
|
|
|
``` sh
|
|
brew install jrnl
|
|
```
|
|
|
|
On other platforms, install `jrnl` using [Python](https://www.python.org/) 3.6+ and [pipx](https://pipxproject.github.io/pipx/):
|
|
|
|
``` sh
|
|
pipx install jrnl
|
|
```
|
|
|
|
The first time you run `jrnl` you will be asked where your journal file
|
|
should be created and whether you wish to encrypt it.
|
|
|
|
## Quickstart
|
|
|
|
To make a new entry, just type
|
|
|
|
``` text
|
|
jrnl yesterday: Called in sick. Used the time to clean, and spent 4h on writing my book.
|
|
```
|
|
|
|
and hit return. `yesterday:` will be interpreted as a time stamp.
|
|
Everything until the first sentence mark (`.?!:`) will be interpreted as
|
|
the title, the rest as the body. In your journal file, the result will
|
|
look like this:
|
|
|
|
``` output
|
|
2012-03-29 09:00 Called in sick.
|
|
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 -
|
|
but you can also [configure](advanced.md) *jrnl* to use your external editor.
|