+
+
+
+
- Tell your friends
-
-
-
-  }} "jrnl")
- Collect your thoughts and notes
-
-
- Collect your thoughts and notes
without leaving the command line
-
-
-
-
$ jrnl today: Started writing my memoirs. On the command line. Like a boss.
-
-
-
-
-
-
-
-
-
diff --git a/docs/_themes/jrnl/layout.html b/docs/_themes/jrnl/layout.html
deleted file mode 100755
index 8cf5e53c..00000000
--- a/docs/_themes/jrnl/layout.html
+++ /dev/null
@@ -1,29 +0,0 @@
-{% if pagename == "index" %}
- {% include "index.html" %}
-{% else %}
- {%- extends "basic/layout.html" %}
-
- {%- block extrahead %}
- {{ super() }}
-
-
-
- {% endblock %}
- {%- block relbar1 %}{% endblock %}
- {%- block relbar2 %}{% endblock %}
-
- {%- block sidebar2 %}
-
- {% endblock %}
-
- {%- block footer %}
-
- {%- endblock %}
-{% endif %}
diff --git a/docs/_themes/jrnl/relations.html b/docs/_themes/jrnl/relations.html
deleted file mode 100755
index 3bbcde85..00000000
--- a/docs/_themes/jrnl/relations.html
+++ /dev/null
@@ -1,19 +0,0 @@
-
-
-
-
-
- Human friendly.
-jrnl has a natural-language interface so you don't have to remember cryptic shortcuts when you're writing down your thoughts.
-
-
-
- Future-proof.
-your journals are stored in plain-text files that will still be readable in 50 years when all your fancy iPad apps will have gone the way of the Dodo.
-
-
-
- Secure.
-Encrypt your journals with the military-grade AES encryption. Even the NSA won't be able to read your dirty secrets.
-
-
-
-
-
-
-
- Accessible anywhere.
-Sync your journals with Dropbox and capture your thoughts where ever you are
-
-
-
- DayOne compatible.
-Read, write and search your DayOne journal from the command line.
-
-
-
- Free & Open Source.
-jrnl is made by a bunch of really friendly and remarkably attractive people. Maybe even you?
-
-
-
- For work and play.
-Effortlessly access several journals for all parts of your life.
-Related Topics
--
-
- Documentation overview
-
- {%- for parent in parents %}
-
- {{ parent.title }}
-
- {%- endfor %}
- {%- if prev %}
-
- Previous: {{ prev.title }} - {%- endif %} - {%- if next %} -
- Next: {{ next.title }} - {%- endif %} - {%- for parent in parents %} -
- {%- endfor %}
-
- - {{ parent.title }}
@beth 5"], - ["--export json", "", "(Exports your entire journal to json)"], - ["--encrypt", "", "(256 bit AES encryption. Crack this, NSA.)"] -] - -var args = document.getElementById("args"); -var input = document.getElementById("input"); -var output = document.getElementById("output"); -var current = 0 -var timer = null; -var fadeInTimer = null; -var fadeOutTimer = null; -var letterTimer = null; -var unletterTimer = null; - -var next = function() { - current = (current + 1) % phrases.length; - reveal(current); - timer = setTimeout(next, 5000); -} - -var prev = function() { - current = (current === 0) ? phrases.length - 1 : current - 1; - reveal(current); - timer = setTimeout(next, 5000); -} - -var reveal = function(idx) { - var args_text = phrases[idx][0]; - var input_text = phrases[idx][1]; - var output_text = phrases[idx][2]; - var old_dix = idx == 0 ? phrases.length - 1 : idx - 1; - console.log(idx, old_dix, "++++++++++++") - var old_args_text = args.innerHTML; - var old_input_text = input.innerHTML; - var old_output_text = output.innerHTML; - console.log(args_text, input_text, output_text) - console.log(old_args_text, old_input_text, old_output_text) - var s4 = function() {fadeIn(output_text, output);} - var s3 = function() {letter(input_text, input, s4);} - var s2 = function() {letter(args_text, args, s3);} - var s1 = function() {unletter(old_args_text, args, s2);} - var s0 = function() {unletter(old_input_text, input, s1);} - fadeOut(old_output_text, output, s0, 10); -} - -var fadeIn = function(text, element, next, step) { - step = step || 0 - var nx = function() { fadeIn(text, element, next, ++step); } - if (step==0) { - element.innerHTML = ""; - fadeInTimer = setTimeout(nx, 550); - return; - } - if (step==1) {element.innerHTML = text;} - if (step>10 || !text) { if (next) {next(); return;} else return;} - element.style.opacity = (step-1)/10; - element.style.filter = 'alpha(opacity=' + (step-1)*10 + ')'; - fadeInTimer = setTimeout(nx, 50); -} - -var fadeOut = function(text, element, next, step) { - if (step===10) element.innerHTML = text; - if (step<0 || !text) { - element.innerHTML = ""; - if (next) {next(); return;} - else return; - } - element.style.opacity = step/10; - element.style.filter = 'alpha(opacity=' + step*10 + ')'; - var nx = function() { fadeOut(text, element, next, --step); } - fadeOutTimer = setTimeout(nx, 50); -} - -var unletter = function(text, element, next, timeout, index) { - timeout = timeout||10; - if (index==null) index = text.length; - if (index==-1 || !text.length) { if (next) {next(); return;} else return;} - element.innerHTML = text.substring(0, index); - var nx = function() { unletter(text, element, next, timeout, --index); } - unletterTimer = setTimeout(nx, timeout); -} - -var letter = function(text, element, next, timeout, index) { - timeout = timeout||35; - index = index||0; - if (index > text.length || !text.length) { if (next) {next(); return;} else return;} - element.innerHTML = text.substring(0, index); - var nx = function() { letter(text, element, next, timeout, ++index); } - letterTimer = setTimeout(nx, timeout); -} - -var reset = function() { - var timers = [timer, fadeInTimer, fadeOutTimer, letterTimer, unletterTimer]; - timers.forEach(function (t) { - clearTimeout(t); - }); - - args.innerHTML = ""; - input.innerHTML = ""; - output.innerHTML = ""; -} - -timer = setTimeout(next, 3000); diff --git a/docs/_themes/jrnl/static/landing.svg b/docs/_themes/jrnl/static/landing.svg deleted file mode 100644 index cbdb9488..00000000 --- a/docs/_themes/jrnl/static/landing.svg +++ /dev/null @@ -1,3558 +0,0 @@ - - - - diff --git a/docs/_themes/jrnl/static/less/docs.less b/docs/_themes/jrnl/static/less/docs.less deleted file mode 100644 index eb12bb48..00000000 --- a/docs/_themes/jrnl/static/less/docs.less +++ /dev/null @@ -1,283 +0,0 @@ -body - { - font-family: "Open Sans", "Helvetica Neue", sans-serif; - font-weight: 300; - color: #333; - background: @white; - } -body:not(.landing) - { - padding:0px 20px; - padding-top: 40px; - h2 - { - margin-top: 40px; - } - } -input - { - background: transparent; - border: 1px solid #999; - .border-radius(3px); - padding: 2px 5px; - color: #666; - font-family: "Open Sans"; - font-weight: 300; - outline: none; - &:focus - { - background: white; - } - } -div.related - { - background: rgba(255,200,200,.2); - } - -* > a.headerlink - { - display: none; - } - -h1, h2, h3, h4, h5, h6 - { - font-weight: 300; - } - -a:link, a:visited - { - color: @orange; - text-decoration: none; - } -a:hover, a:active - { - text-decoration: underline; - color: lighten(@orange, 10); - } - -.literal - { - color: @purple; - font-size: 1em; - background: lighten(@purple-light, 45); - padding: 1px 2px; - .border-radius(2px); - .box-shadow(inset 0px 0px 0px 1px lighten(@purple-light, 30)); - } - -.note - { - .gradient(lighten(@purple-light, 10), lighten(@purple-light-shade, 10)); - .border-radius(5px); - .box-shadow(0px 2px 3px @purple-shade); - padding: 10px 20px 10px 70px; - position: relative; - color: white; - .admonition-title {display: none;} - a { color: lighten(@orange, 30);} - &:before - { - content: ""; - display: block; - .icon; - .icon.info; - position: absolute; - margin: auto; - top: 0; bottom: 0; left: 20px; - } - .literal, .highlight-note - { - color: white; - background: darken(@purple-light, 3); - padding: 1px 3px; - .border-radius(2px); - .box-shadow(inset 0px 0px 0px 1px lighten(@purple-light, 10)); - } - .highlight-note - { - padding: 1px 10px; - pre:before - { - content: "$ "; - color: @orange; - } - } - } - -.highlight - { - background:transparent !important; - } -.highlight-output, .highlight-javascript, .highlight-sh - { - .pre-block; - background: desaturate(lighten(@terminal,10), 10); - pre {color: white;} - } -.highlight-python - { - .terminal; - pre - { - margin: 0 0 10px 0; - &:before - { - content: "$ "; - color: @orange; - } - } - } - -*:hover > a.headerlink - { - display: inline; - color: lighten(@purple-light, 30); - margin-left: 10px; - text-decoration: none; - &:hover { color: @purple-light; } - } - -tt - { - color: @purple; - font-size: 1.2em; - } -ul li { - margin-bottom: 10px; -} - -div.document - { - max-width: 900px; - margin: 20px auto; - position: relative; - } -div.documentwrapper - { - margin-left: 240px; - padding: 0; - } -aside - { - position: absolute; - width: 220px; - top: 0px; - .logo - { - margin: 0 auto 20px auto; - display: block; - width: 90px; - height: 98px; - } - color: #999; - h2, h3, h3 a:link, h3 a:visited - { - color: #777; - } - - a:link, a:visited - { - color: #999; - } - a:hover, a:active - { - color: @orange; - } - input[type=submit] - { - display: none; - } - &>ul - { - margin: 0 4px; - padding: 0; - list-style: none; - &>li - { - margin-bottom: 10px; - font-size: 18px; - color: #777; - a:link, a:visited {color: #777;} - ul - { - margin: 10px 0 0 0; - padding-left: 20px; - font-size: 16px; - color: #999; - a:link, a:visited {color: #999;} - } - } - } - } - -div.footer - { - font-size: .8em; - text-align: center; - margin: 40px 0; - color: #999; - a:link, a:visited {color: #555;} - } - -@media screen and (max-width: 820px) - { - body:not(.landing){ - padding-top: 130px; - .highlight-output,.highlight-python, .highlight-javascript - { - width: auto; - max-width: 500px; - } - .highlight-python - { - pre { margin: -10px 0 10px 0;} - &:before - { - height: 24px !important; - line-height: 24px; - font-size: .7em; - } - &:after - { - background: none; - } - } - aside - { - position: static; - } - div.documentwrapper - { - margin: 0px; - } - h1, .section - { - margin: 0px !important; - } - aside - { - background-color: #f0f0f0; - width: 100%; - margin: 5px -20px; - padding: 5px 20px 10px 20px; - } - #logolink - { - position: absolute; - top: -120px; - left: 50%; - margin-left: -49px; - } - } - - } -@media (-webkit-min-device-pixel-ratio: 1.5), (min--moz-device-pixel-ratio: 1.5), (-o-min-device-pixel-ratio: 3/2), (min-resolution: 1.5dppx) - { - aside .logo, body#landing #upper #logo - { - width: 90px; - height: 98px; - content: url(../img/logo@2x.png); - } - - } diff --git a/docs/_themes/jrnl/static/less/jrnl.less b/docs/_themes/jrnl/static/less/jrnl.less deleted file mode 100644 index ce597b49..00000000 --- a/docs/_themes/jrnl/static/less/jrnl.less +++ /dev/null @@ -1,317 +0,0 @@ -@import "retina"; -@import "3L"; - -@white: #f7f8f9; -@blue: #5e7dc5; -@blue-light: #7c95ca; -@terminal: #2f1e34; -@purple: #47375d; -@purple-shade: #413155; -@purple-light: #725794; -@purple-light-shade: #564371; -@orange: #deaa09; - -.normalize(); -@import "docs.less"; - -.icon, - { - .sprite("../img/icons.png", 32px, 5, 3, 8px); - &.secure {.sprite(0, 0)}; - &.future {.sprite(1, 0)}; - &.search {.sprite(2, 0)}; - &.nli {.sprite(3, 0)}; - &.share {.sprite(0, 1)}; - &.sync {.sprite(0, 1)}; - &.dayone {.sprite(1, 1)}; - &.github {.sprite(2, 1)}; - &.folders{.sprite(3, 1)}; - &.cal {.sprite(4, 1)}; - &.left {.sprite(0, 2)}; - &.right {.sprite(1, 2)}; - &.info {.sprite(2, 2)}; - } - -.pre-block - { - background: @terminal; - .border-radius(6px); - padding: 1px 20px; - margin: 40px auto; - width: 500px; - .box-shadow(0px 1px 8px darken(@white, 30)); - position: relative; - color: @white; - font-family: "Monaco", "Courier New"; - font-size: 12pt; - #args {color: #f6f7b9} - #output {color: #9278b5} - } - -.terminal - { - .pre-block; - @p: 20px; - padding: @p + 30px @p (@p - 10px) @p; - &:before - { - content: "Terminal"; - display: block; - width: 100%; - position: absolute; - left: 0; - .box-shadow(inset 0px 1px 0px #f4f4f4, inset 0px -1px 0px #888); - margin-top: -50px; - // margin: -@p -@p 0px -@p; - text-align: center; - height: 30px; - line-height: 30px; - color: #777; - text-shadow: 0px 1px 0px #ddd; - .border-radius(5px 5px 0px 0px); - .gradient(#eaeaea, #bababa); - } - &:after - { - content: ""; - width: 48px; - height: 30px; - position: absolute; - top: 0px; - left: 10px; - background: url(../img/terminal.png) no-repeat center center; - } - } - -body#landing - { - background-color: @purple; - font-family: "Open Sans", "Helvetica Neue", sans-serif; - font-weight: 300; - #twitter - { - display: block; - position: absolute; - top: 20px; - right: 20px; - border: 1px solid @purple; - padding: 5px 10px 5px 30px; - color: @purple; - .border-radius(3px); - .opacity(.7); - background: url(../img/twitter.png) 8px center no-repeat transparent; - &:hover, &:active - { - .opacity(1); - text-decoration: none; - } - } - #title, .row3, .row4, #prompt - { - width: 900px; - margin: 0px auto; - } - #upper - { - .clearfix; - background: @white; - .box-shadow(inset 0px -6px 6px -3px darken(@white, 10)); - #title - { - width: 650px; - margin: 150px auto 75px auto; - } - img - { - float: left; - margin-right: 30px; - } - h1 - { - color: @purple-light-shade; - font-weight: 300; - } - #prompt - { - width: 640px; - margin: 0 auto; - .clearfix; - } - .terminal - { - .border-radius(6px 6px 0px 0px); - float: left; - margin: 0px; - width: 500px; - min-height: 134px; - .border-box-sizing; - } - .pleft, .pright - { - text-align: center; - .border-box-sizing; - float: left; - padding-top: 50px; - width: 70px; - i {.opacity(60);} - i:hover {.opacity(1000); cursor: pointer;} - } - } - #nav - { - .gradient(@blue-light, @blue); - height: 60px; - .box-shadow(0px 6px 6px -3px @purple-shade); - text-align: center; - a#twitter-nav {display: none;} - a - { - color: @white; - text-shadow: 0px -1px 0px darken(@blue, 30); - text-decoration: none; - font-size: 14pt; - line-height: 60px; - margin: 0 40px; - &:hover - { - color: lighten(@orange, 20); - text-shadow: 0px -1px 0px darken(@orange, 15); - } - } - a.cta - { - .gradient(@purple-light, @purple-light-shade); - .box-shadow(0px 1px 0px @purple-shade); - .border-radius(5px); - padding: 6px 10px 5px 10px; - white-space: nowrap; - &:hover - { - .gradient(lighten(@orange, 10), darken(@orange, 5)); - .box-shadow(0px 1px 0px darken(@orange, 15)); - text-shadow: 0px -1px 0px darken(@orange, 15); - color: @white; - - } - } - } - #lower - { - color: @white; - padding-top: 40px; - a - { - color: @orange; - text-decoration: none; - &:hover - { - color: lighten(@orange, 20); - text-decoration: underline; - } - } - .row3, .row4 { - .clearfix; - margin-bottom: 20px; - .col - { - position: relative; - padding-left: 40px; - i - { - position: absolute; - left: 0; - top: 16px; - } - h3 {font-size: 12pt; margin-bottom: .5em;} - p {font-size: 10pt; margin: 0;} - float: left; - width: 25%; - padding-right: 2%; - .border-box-sizing; - &:last-child {padding-right: 0;} - } - } - .row3 .col { width: 33.3333%; } - .row4 .col { color: mix(@white, @purple, 80); i {.opacity(80);}} - } - } - -@media screen and (max-width: 680px) - { - body#landing - { - #nav - { - height: auto; - padding-bottom: 10px; - a, a#twitter-nav - { - display: block; - } - a.cta - { - margin: 10px; - padding: 1px; - } - } - #upper - { - #twitter { display: none;} - #title - { - margin: 30px 0 10px 0; - } - #logo - { - backgound: red; - display: block; - float: none; - margin: 0px auto; - } - #title br {display: none;} - .pleft, .pright {display: none;} - #prompt, #title - { - width: 100%; - .border-box-sizing; - padding: 0px 20px; - } - .terminal - { - width: 100%; - } - } - } - } - -@media screen and (max-width: 900px) - { - body#landing - { - #lower - { - padding: 40px 20px; - .row3, .row4 - { - margin: 0px; - width: auto; - } - .row3 .col, .row4 .col - { - float: none; - width: 100%; - text-align: center; - padding: 0px; - margin: 0 0 40px 0; - h3 {font-size: 1.5em;} - p {font-size: 1em;} - - i - { - position: static; - margin-bottom: -20px; - } - } - } - } - } diff --git a/docs/_themes/jrnl/static/less/retina.less b/docs/_themes/jrnl/static/less/retina.less deleted file mode 100644 index 3c006c45..00000000 --- a/docs/_themes/jrnl/static/less/retina.less +++ /dev/null @@ -1,35 +0,0 @@ -// A helper mixin for applying high-resolution background images (http://www.retinajs.com) - -@highdpi: ~"(-webkit-min-device-pixel-ratio: 1.5), (min--moz-device-pixel-ratio: 1.5), (-o-min-device-pixel-ratio: 3/2), (min-resolution: 1.5dppx)"; - -.at2x(@path, @w: auto, @h: auto) { - background-image: url(@path); - @at2x_path: ~`@{path}.replace(/\.\w+$/, function(match) { return "@2x" + match; })`; - background-size: @w @h; - - @media @highdpi { - background-image: url("@{at2x_path}"); - } -} - -// Sprite mixin, see https://coderwall.com/p/oztebw - -.sprite (@path, @size, @w, @h, @pad: 0) when (isstring(@path)) - { - background-image: url(@path); - width: @size; - height: @size; - display: inline-block; - @at2x_path: ~`@{path}.replace(/\.[\w\?=]+$/, function(match) { return "@2x" + match; })`; - font-size: @size + @pad; - background-size: (@size + @pad) * @w (@size + @pad) * @h; - @media @highdpi - { - background-image: url("@{at2x_path}"); - } - } - -.sprite(@x, @y) - { - background-position: -@x * 1em -@y * 1em; - } diff --git a/docs/_themes/jrnl/static/sprites.svg b/docs/_themes/jrnl/static/sprites.svg deleted file mode 100755 index a8420b9b..00000000 --- a/docs/_themes/jrnl/static/sprites.svg +++ /dev/null @@ -1,96 +0,0 @@ - - - - diff --git a/docs/_themes/jrnl/theme.conf b/docs/_themes/jrnl/theme.conf deleted file mode 100755 index fc3d3735..00000000 --- a/docs/_themes/jrnl/theme.conf +++ /dev/null @@ -1,7 +0,0 @@ -[theme] -inherit = basic -stylesheet = css/jrnl.css -pygments_style = flask_theme_support.FlaskyStyle - -[options] -touch_icon = diff --git a/docs/advanced.md b/docs/advanced.md new file mode 100644 index 00000000..764ff98a --- /dev/null +++ b/docs/advanced.md @@ -0,0 +1,117 @@ + + +# Advanced Usage + +## Configuration File + +`jrnl` has a wide variety of options that can be customized through the config file, +including templates, formats, multiple journals, and more. See +the [configuration file reference](./reference-config-file.md) for details +or read on for some common use cases. + +### Multiple journal files + +You can configure `jrnl`to use with multiple journals (eg. +`private` and `work`) by defining more journals in your [config file](./reference-config-file.md), +for example: + +``` yaml +journals: + default: ~/journal.txt + work: ~/work.txt +``` + +The `default` journal gets created the first time you start `jrnl` +Now you can access the `work` journal by using `jrnl work` instead of +`jrnl`, eg. + +``` sh +jrnl work at 10am: Meeting with @Steve +jrnl work -n 3 +``` + +will both use `~/work.txt`, while `jrnl -n 3` will display the last +three entries from `~/journal.txt` (and so does `jrnl default -n 3`). + +You can also override the default options for each individual journal. +If your `jrnl.yaml` looks like this: + +``` yaml +encrypt: false +journals: + default: ~/journal.txt + work: + journal: ~/work.txt + encrypt: true + food: ~/my_recipes.txt +``` + +Your `default` and your `food` journals won't be encrypted, however your +`work` journal will! + +You can override all options that are present at +the top level of `jrnl.yaml`, just make sure that at the very least +you specify a `journal: ...` key that points to the journal file of +that journal. + +Consider the following example configuration + +``` yaml +editor: vi -c startinsert +journals: + default: ~/journal.txt + work: + journal: ~/work.txt + encrypt: true + display_format: json + editor: code -rw + food: + display_format: markdown + journal: ~/recipes.txt +``` + +The `work` journal is encrypted, prints to `json` by default, and is edited using an existing window of VSCode. Similarly, the `food` journal prints to markdown by default, but uses all the other defaults. + +### Modifying Configurations from the Command line + +You can override a configuration field for the current instance of `jrnl` using `--config-override CONFIG_KEY CONFIG_VALUE` where `CONFIG_KEY` is a valid configuration field, specified in dot notation and `CONFIG_VALUE` is the (valid) desired override value. The dot notation can be used to change config keys within other keys, such as `colors.title` for the `title` key within the `colors` key. + +You can specify multiple overrides as multiple calls to `--config-override`. + +!!! note + These overrides allow you to modify ***any*** field of your jrnl configuration. We trust that you know what you are doing. + +#### Examples: + +``` sh +# Create an entry using the `stdin` prompt, for rapid logging +jrnl --config-override editor "" + +# Populate a project's log +jrnl --config-override journals.todo "$(git rev-parse --show-toplevel)/todo.txt" todo find my towel + +# Pass multiple overrides +jrnl --config-override display_format fancy --config-override linewrap 20 \ +--config-override colors.title green +``` + +### Using an alternate config + +You can specify an alternate configuration file for the current instance of `jrnl` using `--config-file CONFIG_FILE_PATH` where +`CONFIG_FILE_PATH` is a path to an alternate `jrnl` configuration file. + +#### Examples: + +``` sh +# Use personalised configuration file for personal journal entries +jrnl --config-file ~/foo/jrnl/personal-config.yaml + +# Use alternate configuration file for work-related entries +jrnl --config-file ~/foo/jrnl/work-config.yaml + +# Use default configuration file (created on first run) +jrnl +``` diff --git a/docs/advanced.rst b/docs/advanced.rst deleted file mode 100644 index 827b8b0b..00000000 --- a/docs/advanced.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. _advanced: - -Advanced Usage -============== - -Configuration File -------------------- - -You can configure the way jrnl behaves in a configuration file. By default, this is ``~/.jrnl_config``. If you have the ``XDG_CONFIG_HOME`` variable set, the configuration file will be saved under ``$XDG_CONFIG_HOME/jrnl``. - -.. note:: - - On Windows, The configuration file is typically found at ``C:\Users\[Your Username]\.jrnl_config``. - - -The configuration file is a simple JSON file with the following options and can be edited with any plain text editor. - -- ``journals`` - paths to your journal files -- ``editor`` - if set, executes this command to launch an external editor for writing your entries, e.g. ``vim``. Some editors require special options to work properly, see :doc:`FAQ