","
"];c.fn.extend({text:function(a){if(c.isFunction(a))return this.each(function(b){var d=
+c(this);d.text(a.call(this,b,d.text()))});if(typeof a!=="object"&&a!==w)return this.empty().append((this[0]&&this[0].ownerDocument||s).createTextNode(a));return c.text(this)},wrapAll:function(a){if(c.isFunction(a))return this.each(function(d){c(this).wrapAll(a.call(this,d))});if(this[0]){var b=c(a,this[0].ownerDocument).eq(0).clone(true);this[0].parentNode&&b.insertBefore(this[0]);b.map(function(){for(var d=this;d.firstChild&&d.firstChild.nodeType===1;)d=d.firstChild;return d}).append(this)}return this},
+wrapInner:function(a){if(c.isFunction(a))return this.each(function(b){c(this).wrapInner(a.call(this,b))});return this.each(function(){var b=c(this),d=b.contents();d.length?d.wrapAll(a):b.append(a)})},wrap:function(a){return this.each(function(){c(this).wrapAll(a)})},unwrap:function(){return this.parent().each(function(){c.nodeName(this,"body")||c(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.appendChild(a)})},
+prepend:function(){return this.domManip(arguments,true,function(a){this.nodeType===1&&this.insertBefore(a,this.firstChild)})},before:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,this)});else if(arguments.length){var a=c(arguments[0]);a.push.apply(a,this.toArray());return this.pushStack(a,"before",arguments)}},after:function(){if(this[0]&&this[0].parentNode)return this.domManip(arguments,false,function(b){this.parentNode.insertBefore(b,
+this.nextSibling)});else if(arguments.length){var a=this.pushStack(this,"after",arguments);a.push.apply(a,c(arguments[0]).toArray());return a}},remove:function(a,b){for(var d=0,f;(f=this[d])!=null;d++)if(!a||c.filter(a,[f]).length){if(!b&&f.nodeType===1){c.cleanData(f.getElementsByTagName("*"));c.cleanData([f])}f.parentNode&&f.parentNode.removeChild(f)}return this},empty:function(){for(var a=0,b;(b=this[a])!=null;a++)for(b.nodeType===1&&c.cleanData(b.getElementsByTagName("*"));b.firstChild;)b.removeChild(b.firstChild);
+return this},clone:function(a){var b=this.map(function(){if(!c.support.noCloneEvent&&!c.isXMLDoc(this)){var d=this.outerHTML,f=this.ownerDocument;if(!d){d=f.createElement("div");d.appendChild(this.cloneNode(true));d=d.innerHTML}return c.clean([d.replace(Ja,"").replace(/=([^="'>\s]+\/)>/g,'="$1">').replace(V,"")],f)[0]}else return this.cloneNode(true)});if(a===true){ra(this,b);ra(this.find("*"),b.find("*"))}return b},html:function(a){if(a===w)return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(Ja,
+""):null;else if(typeof a==="string"&&!ta.test(a)&&(c.support.leadingWhitespace||!V.test(a))&&!F[(La.exec(a)||["",""])[1].toLowerCase()]){a=a.replace(Ka,Ma);try{for(var b=0,d=this.length;b' + _('Searching') + '
').appendTo(this.out); + this.dots = $('').appendTo(this.title); + this.status = $('').appendTo(this.out); + this.output = $('\
+ \
+
\
+ ';
+
+ var replyTemplate = '\
+ \
+
\
+ \
+ \ + <%username%>\ + \ + <%time.delta%>\ +
\ +<#text#>
\
+ \ + \ + reply ▿\ + proposal ▹\ + \ + \ + \ +
\ +\ +<#proposal_diff#>\ +\ +
+
+
+
+
\ No newline at end of file
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100644
index 43b60517..00000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,177 +0,0 @@
-# Makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-PAPER =
-BUILDDIR = _build
-
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4 = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
-
-help:
- @echo "Please use \`make
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Advanced Usage¶
+
+
+Configuration File¶
+The configuration file is a simple JSON file with the following options.
+-
+
-
+
- journals +
paths to your journal files
+
+
+-
+
- editor +
if set, executes this command to launch an external editor for writing your entries, e.g. vim or subl -w (note the -w flag to make sure _jrnl_ waits for Sublime Text to close the file before writing into the journal. If you’re using MacVim, that would be mvim -f).
+
+
+-
+
- encrypt +
if true, encrypts your journal using AES.
+
+
+-
+
- tagsymbols +
Symbols to be interpreted as tags. (__See note below__)
+
+
+-
+
- default_hour and default_minute +
if you supply a date, such as last thursday, but no specific time, the entry will be created at this time
+
+
+-
+
- timeformat +
how to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference
+
+
+-
+
- highlight +
if true, tags will be highlighted in cyan.
+
+
+-
+
- linewrap +
controls the width of the output. Set to false if you don’t want to wrap long lines.
+
+
+
+
+
+
+Note
+Although it seems intuitive to use the # character for tags, there’s a drawback: on most shells, this is interpreted as a meta-character starting a comment. This means that if you type
+jrnl Implemented endless scrolling on the #frontend of our website.
+your bash will chop off everything after the # before passing it to _jrnl_). To avoid this, wrap your input into quotation marks like this:
+jrnl "Implemented endless scrolling on the #frontend of our website."
+Or use the built-in prompt or an external editor to compose your entries.
+
+
+DayOne Integration¶
+Using your DayOne journal instead of a flat text file is dead simple - instead of pointing to a text file, change your .jrnl_conf to point to your DayOne journal. This is a folder ending with .dayone, and it’s located at
+-
+
- ~/Library/Application Support/Day One/ by default +
- ~/Dropbox/Apps/Day One/ if you’re syncing with Dropbox and +
- ~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/ if you’re syncing with iCloud. +
Instead of all entries being in a single file, each entry will live in a separate plist file. You can also star entries when you write them:
+++jrnl -star yesterday: Lunch with @Arthur
+
+
+
+
+
+
+Multiple journal files¶
+You can configure _jrnl_ to use with multiple journals (eg. private and work) by defining more journals in your .jrnl_config, for example:
+{
+...
+ "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.
+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 you .jrnl_conf looks like this:
+{
+ ...
+ "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_conf, just make sure that at the very least you specify a "journal": ... key that points to the journal file of that journal.
+
+
+Note
+Changing encrypt to a different value will not encrypt or decrypt your journal file, it merely says whether or not your journal is encrypted. Hence manually changing this option will most likely result in your journal file being impossible to load.
+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 }}
+
+
+
+
\ No newline at end of file
diff --git a/export.html b/export.html
new file mode 100644
index 00000000..88fc3edb
--- /dev/null
+++ b/export.html
@@ -0,0 +1,142 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Encryption¶
+
+
+
+
+
+
+Encrypting and decrypting¶
+If you don’t choose to encrypt your file when you run jrnl for the first time, you can encrypt your existing journal file or change its password using
+jrnl --encrypt
+If it is already encrypted, you will first be asked for the current password. You can then enter a new password and your plain journal will replaced by the encrypted file. Conversely,
+jrnl --decrypt
+will replace your encrypted journal file by a Journal in plain text. You can also specify a filename, ie. jrnl –decrypt plain_text_copy.txt, to leave your original file untouched.
+
+
+Storing passwords in your keychain¶
+Whenever you encrypt your journal, you are asked whether you want to store the encryption password in your keychain. If you do this, you won’t have to enter your password every time you want to write or read your journal.
+If you don’t initially store the password in the keychain but decide to do so at a later point – or maybe want to store it on one computer but not on another – you can simply run jrnl –encrypt on an encrypted journal and use the same password again.
+
+
+
+
+Manual decryption¶
+Should you ever want to decrypt your journal manually, you can do so with any program that supports the AES algorithm. The key used for encryption is the SHA-256-hash of your password, and the IV (initialisation vector) is stored in the first 16 bytes of the encrypted file. So, to decrypt a journal file in python, run:
+import hashlib, Crypto.Cipher
+key = hashlib.sha256(my_password).digest()
+with open("my_journal.txt") as f:
+ cipher = f.read()
+ crypto = AES.new(key, AES.MODE_CBC, iv = cipher[:16])
+ plain = crypto.decrypt(cipher[16:])
+
+
+
+
+
\ No newline at end of file
diff --git a/features/core.feature b/features/core.feature
deleted file mode 100644
index d5a6fa7f..00000000
--- a/features/core.feature
+++ /dev/null
@@ -1,36 +0,0 @@
-Feature: Basic reading and writing to a journal
-
- Scenario: Loading a sample journal
- Given we use the config "basic.json"
- When we run "jrnl -n 2"
- Then we should get no error
- and the output should be
- """
- 2013-06-09 15:39 My first entry.
- | Everything is alright
-
- 2013-06-10 15:40 Life is good.
- | But I'm better.
- """
-
- Scenario: Writing an entry from command line
- Given we use the config "basic.json"
- When we run "jrnl 23 july 2013: A cold and stormy day. I ate crisps on the sofa."
- Then we should see the message "Entry added"
- When we run "jrnl -n 1"
- Then the output should contain "2013-07-23 09:00 A cold and stormy day."
-
- Scenario: Emoji support
- Given we use the config "basic.json"
- When we run "jrnl 23 july 2013: 🌞 sunny day. Saw an 🐘"
- Then we should see the message "Entry added"
- When we run "jrnl -n 1"
- Then the output should contain "🌞"
- and the output should contain "🐘"
-
- Scenario: Writing an entry at the prompt
- Given we use the config "basic.json"
- When we run "jrnl" and enter "25 jul 2013: I saw Elvis. He's alive."
- Then we should get no error
- and the journal should contain "2013-07-25 09:00 I saw Elvis."
- and the journal should contain "He's alive."
diff --git a/features/data/configs/basic.json b/features/data/configs/basic.json
deleted file mode 100644
index 2dc11d73..00000000
--- a/features/data/configs/basic.json
+++ /dev/null
@@ -1,14 +0,0 @@
-{
- "default_hour": 9,
- "timeformat": "%Y-%m-%d %H:%M",
- "linewrap": 80,
- "encrypt": false,
- "editor": "",
- "default_minute": 0,
- "highlight": true,
- "password": "",
- "journals": {
- "default": "features/journals/simple.journal"
- },
- "tagsymbols": "@"
-}
diff --git a/features/data/configs/broken.json b/features/data/configs/broken.json
deleted file mode 100644
index bcd96f24..00000000
--- a/features/data/configs/broken.json
+++ /dev/null
@@ -1,15 +0,0 @@
-{
- "default_hour": 9,
- "timeformat": "%Y-%m-%d %H:%M",
- "linewrap": 80,
- "encrypt": false,
- "editor": "",
- "default_minute": 0,
- "highlight": true
- "password": "",
- "journals": {
- "default": "features/journals/simple.journal"
- "work": "features/journals/work.journal",
- },
- "tagsymbols": "@"
-}
diff --git a/features/data/configs/dayone.json b/features/data/configs/dayone.json
deleted file mode 100644
index 2baf0080..00000000
--- a/features/data/configs/dayone.json
+++ /dev/null
@@ -1,14 +0,0 @@
-{
- "default_hour": 9,
- "timeformat": "%Y-%m-%d %H:%M",
- "linewrap": 80,
- "encrypt": false,
- "editor": "",
- "default_minute": 0,
- "highlight": true,
- "password": "",
- "journals": {
- "default": "features/journals/dayone.dayone"
- },
- "tagsymbols": "@"
-}
diff --git a/features/data/configs/empty_folder.json b/features/data/configs/empty_folder.json
deleted file mode 100644
index d270db03..00000000
--- a/features/data/configs/empty_folder.json
+++ /dev/null
@@ -1,14 +0,0 @@
-{
- "default_hour": 9,
- "timeformat": "%Y-%m-%d %H:%M",
- "linewrap": 80,
- "encrypt": false,
- "editor": "",
- "default_minute": 0,
- "highlight": true,
- "password": "",
- "journals": {
- "default": "features/journals/empty_folder"
- },
- "tagsymbols": "@"
-}
diff --git a/features/data/configs/encrypted.json b/features/data/configs/encrypted.json
deleted file mode 100644
index a498974b..00000000
--- a/features/data/configs/encrypted.json
+++ /dev/null
@@ -1,14 +0,0 @@
-{
- "default_hour": 9,
- "timeformat": "%Y-%m-%d %H:%M",
- "linewrap": 80,
- "encrypt": true,
- "editor": "",
- "default_minute": 0,
- "highlight": true,
- "password": "",
- "journals": {
- "default": "features/journals/encrypted.journal"
- },
- "tagsymbols": "@"
-}
diff --git a/features/data/configs/encrypted_with_pw.json b/features/data/configs/encrypted_with_pw.json
deleted file mode 100644
index 1a277240..00000000
--- a/features/data/configs/encrypted_with_pw.json
+++ /dev/null
@@ -1,14 +0,0 @@
-{
- "default_hour": 9,
- "timeformat": "%Y-%m-%d %H:%M",
- "linewrap": 80,
- "encrypt": true,
- "editor": "",
- "default_minute": 0,
- "highlight": true,
- "password": "bad doggie no biscuit",
- "journals": {
- "default": "features/journals/encrypted.journal"
- },
- "tagsymbols": "@"
-}
diff --git a/features/data/configs/multiple.json b/features/data/configs/multiple.json
deleted file mode 100644
index 980c9353..00000000
--- a/features/data/configs/multiple.json
+++ /dev/null
@@ -1,17 +0,0 @@
-{
- "default_hour": 9,
- "timeformat": "%Y-%m-%d %H:%M",
- "linewrap": 80,
- "encrypt": false,
- "editor": "",
- "default_minute": 0,
- "highlight": true,
- "password": "",
- "journals": {
- "default": "features/journals/simple.journal",
- "simple": "features/journals/simple.journal",
- "work": "features/journals/work.journal",
- "ideas": "features/journals/nothing.journal"
- },
- "tagsymbols": "@"
-}
diff --git a/features/data/configs/tags.json b/features/data/configs/tags.json
deleted file mode 100644
index dc69950c..00000000
--- a/features/data/configs/tags.json
+++ /dev/null
@@ -1,14 +0,0 @@
-{
- "default_hour": 9,
- "timeformat": "%Y-%m-%d %H:%M",
- "linewrap": 80,
- "encrypt": false,
- "editor": "",
- "default_minute": 0,
- "highlight": true,
- "password": "",
- "journals": {
- "default": "features/journals/tags.journal"
- },
- "tagsymbols": "@"
-}
diff --git a/features/data/journals/dayone.dayone/entries/044F3747A38546168B572C2E3F217FA2.doentry b/features/data/journals/dayone.dayone/entries/044F3747A38546168B572C2E3F217FA2.doentry
deleted file mode 100644
index 2bb8e3c3..00000000
--- a/features/data/journals/dayone.dayone/entries/044F3747A38546168B572C2E3F217FA2.doentry
+++ /dev/null
@@ -1,34 +0,0 @@
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Import and Export¶
+
+
+
+
+
+Tag export¶
+With:
+jrnl --tags
+you’ll get a list of all tags you used in your journal, sorted by most frequent. Tags occurring several times in the same entry are only counted as one.
+
+
+
+JSON export¶
+Can do:
+jrnl --export json
+Why not create a beautiful timeline of your journal?
+
+
+
+
+Markdown export¶
+Use:
+jrnl --export markdown
+Markdown is a simple markup language that is human readable and can be used to be rendered to other formats (html, pdf). This README for example is formatted in markdown and github makes it look nice.
+
+
+
+
+
+Export to files¶
+You can specify the output file of your exported journal using the -o argument:
+jrnl --export 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:
+jrnl --export json -o my_entries/
+The contents of my_entries/ will then look like this:
+my_entries/
+|- 2013_06_03_a-beautiful-day.json
+|- 2013_06_07_dinner-with-gabriel.json
+|- ...
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/_themes/jrnl/index.html b/index.html
old mode 100755
new mode 100644
similarity index 81%
rename from docs/_themes/jrnl/index.html
rename to index.html
index b475bf51..cedf44fb
--- a/docs/_themes/jrnl/index.html
+++ b/index.html
@@ -1,4 +1,6 @@
-
+
+
+
@@ -12,15 +14,15 @@
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+ +
+
+
+
+
+
Tell your friends
-  }} "jrnl")
+ 
Collect your thoughts and notes
+
Collect your thoughts and notes
without leaving the command line
@@ -30,10 +32,10 @@
@@ -77,12 +79,12 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Getting started¶
+
+
+
+
+Installation¶
+Install jrnl using pip
+pip install jrnl
+Or, if you want the option to encrypt your journal,
+pip install jrnl[encrypted]
+to install the dependencies for encrypting journals as well.
+
+
+Note
+Installing the encryption library, pycrypto, requires a gcc compiler. For this reason, jrnl will not install pycrypto unless explicitly told so like this. You can install PyCyrypto manually first or install it with pip install pycrypto if you have a gcc compiler.
+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:
+jrnl yesterday: Called in sick. Used the time to clean the house 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:
+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 jrnl to use your external editor.
+
\ + Sort by:\ + best rated\ + newest\ + oldest\ +
\ +\ +
Add a comment\ + (markup):
\ +