mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-11 09:08:32 +02:00
Moving from sphinx to mkdocs
This commit is contained in:
Manuel Ebert
parent
d3921d9e47
commit
183378d575
35 changed files with 1672 additions and 1055 deletions
177
docs/Makefile
177
docs/Makefile
|
|
@ -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 <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
|
||||
clean:
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/jrnl.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/jrnl.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/jrnl"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/jrnl"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
BIN
docs/_themes/jrnl/static/img/favicon-152.png
vendored
BIN
docs/_themes/jrnl/static/img/favicon-152.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 3.2 KiB After Width: | Height: | Size: 12 KiB |
BIN
docs/_themes/jrnl/static/img/favicon.ico
vendored
BIN
docs/_themes/jrnl/static/img/favicon.ico
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 5.4 KiB After Width: | Height: | Size: 5.4 KiB |
BIN
docs/_themes/jrnl/static/img/logo.png
vendored
BIN
docs/_themes/jrnl/static/img/logo.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 2.7 KiB After Width: | Height: | Size: 5.3 KiB |
BIN
docs/_themes/jrnl/static/img/logo@2x.png
vendored
BIN
docs/_themes/jrnl/static/img/logo@2x.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 5.5 KiB After Width: | Height: | Size: 14 KiB |
6
docs/_themes/jrnl/static/less/docs.less
vendored
6
docs/_themes/jrnl/static/less/docs.less
vendored
|
|
@ -114,7 +114,7 @@ a:hover, a:active
|
|||
background: desaturate(lighten(@terminal,10), 10);
|
||||
pre {color: white;}
|
||||
}
|
||||
.highlight-python
|
||||
.highlight-python, .highlight-sh
|
||||
{
|
||||
.terminal;
|
||||
pre
|
||||
|
|
@ -223,12 +223,12 @@ div.footer
|
|||
{
|
||||
body:not(.landing){
|
||||
padding-top: 130px;
|
||||
.highlight-output,.highlight-python, .highlight-javascript
|
||||
.highlight-output, .highlight-python, .highlight-javascript, .highlight-sh
|
||||
{
|
||||
width: auto;
|
||||
max-width: 500px;
|
||||
}
|
||||
.highlight-python
|
||||
.highlight-python, .highlight-sh
|
||||
{
|
||||
pre { margin: -10px 0 10px 0;}
|
||||
&:before
|
||||
|
|
|
|||
147
docs/advanced.md
Normal file
147
docs/advanced.md
Normal file
|
|
@ -0,0 +1,147 @@
|
|||
# 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 as
|
||||
`$XDG_CONFIG_HOME/jrnl/.jrnl_config`.
|
||||
|
||||
!!! 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 `FAQ <recipes>` for details.
|
||||
- `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_config` to point
|
||||
to your DayOne journal. This is a folder named something like
|
||||
`Journal_dayone` or `Journal.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. So your `.jrnl_config` should look like this:
|
||||
|
||||
``` javascript
|
||||
{
|
||||
...
|
||||
"journals": {
|
||||
"default": "~/journal.txt",
|
||||
"dayone": "~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/Journal_dayone"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 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:
|
||||
|
||||
``` javascript
|
||||
{
|
||||
...
|
||||
"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 you `.jrnl_config` looks like this:
|
||||
|
||||
``` javascript
|
||||
{
|
||||
...
|
||||
"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_config`, 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.
|
||||
|
||||
### Known Issues
|
||||
|
||||
- The Windows shell prior to Windows 7 has issues with unicode
|
||||
encoding. If you want to use non-ascii characters, change the
|
||||
codepage with `chcp 1252` before using
|
||||
`jrnl` (Thanks to Yves Pouplard for
|
||||
solving this!)
|
||||
- `jrnl`relies on the PyCrypto
|
||||
package to encrypt journals, which has some known problems with
|
||||
installing on Windows and within virtual environments.
|
||||
|
|
@ -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 <recipes>` for details.
|
||||
- ``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
|
||||
|
||||
.. code-block:: note
|
||||
|
||||
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:
|
||||
|
||||
.. code-block:: note
|
||||
|
||||
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_config`` to point to your DayOne journal. This is a folder named something like ``Journal_dayone`` or ``Journal.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. So your ``.jrnl_config`` should look like this:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
{
|
||||
...
|
||||
"journals": {
|
||||
"default": "~/journal.txt",
|
||||
"dayone": "~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/Journal_dayone"
|
||||
}
|
||||
|
||||
|
||||
Alfred Integration
|
||||
------------------
|
||||
|
||||
You can use _jrnl_ with the popular `Alfred <https://www.alfredapp.com/>`_ app with `this handy workflow <http://www.packal.org/workflow/jrnl>`_.
|
||||
|
||||
|
||||
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:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
{
|
||||
...
|
||||
"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_config`` looks like this:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
{
|
||||
...
|
||||
"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_config``, 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.
|
||||
|
||||
Known Issues
|
||||
~~~~~~~~~~~~
|
||||
|
||||
- The Windows shell prior to Windows 7 has issues with Unicode encoding. If you want to use non-ASCII characters, change the code page with ``chcp 1252`` before using `jrnl` (Thanks to Yves Pouplard for solving this!)
|
||||
- _jrnl_ relies on the `PyCrypto` package to encrypt journals, which has some known problems with installing on Windows and within virtual environments.
|
||||
79
docs/assets/highlight.css
Normal file
79
docs/assets/highlight.css
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
/*
|
||||
|
||||
Atom One Dark With support for ReasonML by Gidi Morris, based off work by Daniel Gamage
|
||||
|
||||
Original One Dark Syntax theme from https://github.com/atom/one-dark-syntax
|
||||
|
||||
*/
|
||||
.hljs {
|
||||
display: block;
|
||||
overflow-x: auto;
|
||||
padding: 0.5em;
|
||||
line-height: 1.3em;
|
||||
color: #e2e8f2;
|
||||
background: #383e49;
|
||||
border-radius: 5px;
|
||||
font-size: 0.9rem;
|
||||
line-height: 1.3rem;
|
||||
}
|
||||
.hljs-keyword, .hljs-operator {
|
||||
color: #F92672;
|
||||
}
|
||||
.hljs-pattern-match {
|
||||
color: #F92672;
|
||||
}
|
||||
.hljs-pattern-match .hljs-constructor {
|
||||
color: #61aeee;
|
||||
}
|
||||
.hljs-function {
|
||||
color: #61aeee;
|
||||
}
|
||||
.hljs-function .hljs-params {
|
||||
color: #A6E22E;
|
||||
}
|
||||
.hljs-function .hljs-params .hljs-typing {
|
||||
color: #FD971F;
|
||||
}
|
||||
.hljs-module-access .hljs-module {
|
||||
color: #7e57c2;
|
||||
}
|
||||
.hljs-constructor {
|
||||
color: #e2b93d;
|
||||
}
|
||||
.hljs-constructor .hljs-string {
|
||||
color: #9CCC65;
|
||||
}
|
||||
.hljs-comment, .hljs-quote {
|
||||
color: #b18eb1;
|
||||
font-style: italic;
|
||||
}
|
||||
.hljs-doctag, .hljs-formula {
|
||||
color: #c678dd;
|
||||
}
|
||||
.hljs-section, .hljs-name, .hljs-selector-tag, .hljs-deletion, .hljs-subst {
|
||||
color: #e06c75;
|
||||
}
|
||||
.hljs-literal {
|
||||
color: #56b6c2;
|
||||
}
|
||||
.hljs-string, .hljs-regexp, .hljs-addition, .hljs-attribute, .hljs-meta-string {
|
||||
color: #98c379;
|
||||
}
|
||||
.hljs-built_in, .hljs-class .hljs-title {
|
||||
color: #e6c07b;
|
||||
}
|
||||
.hljs-attr, .hljs-variable, .hljs-template-variable, .hljs-type, .hljs-selector-class, .hljs-selector-attr, .hljs-selector-pseudo, .hljs-number {
|
||||
color: #d19a66;
|
||||
}
|
||||
.hljs-symbol, .hljs-bullet, .hljs-link, .hljs-meta, .hljs-selector-id, .hljs-title {
|
||||
color: #61aeee;
|
||||
}
|
||||
.hljs-emphasis {
|
||||
font-style: italic;
|
||||
}
|
||||
.hljs-strong {
|
||||
font-weight: bold;
|
||||
}
|
||||
.hljs-link {
|
||||
text-decoration: underline;
|
||||
}
|
||||
199
docs/assets/theme.css
Normal file
199
docs/assets/theme.css
Normal file
|
|
@ -0,0 +1,199 @@
|
|||
|
||||
/* ------------------------------------------------------------ */
|
||||
/* Overrides for jrnl theme */
|
||||
/* ------------------------------------------------------------ */
|
||||
|
||||
:root {
|
||||
--sidebar: #47375d;
|
||||
--sidebar-dark: #47375d;
|
||||
--off-white: rgba(255,255,255,.7);
|
||||
}
|
||||
|
||||
body.wy-body-for-nav, section.wy-nav-content-wrap {
|
||||
background-color: rgb(252,252,252);
|
||||
}
|
||||
|
||||
pre {
|
||||
background-color: transparent;
|
||||
border: none;
|
||||
margin: 1em -1em;
|
||||
}
|
||||
|
||||
pre code {
|
||||
padding: 1em 1.5em !important;
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
h1,h2 ,h3, h4, h5, h6 {
|
||||
font-family: "Open Sans", "Helvetica Neue", Helvetica, sans-serif;
|
||||
font-weight: 600;
|
||||
margin-top: 2rem;
|
||||
margin-bottom: 0.5rem;
|
||||
}
|
||||
p, td, tr, div, li {
|
||||
font-family: "Open Sans", "Helvetica Neue", Helvetica, sans-serif;
|
||||
font-weight: 00;
|
||||
}
|
||||
|
||||
p {
|
||||
margin: 1em 0em;
|
||||
}
|
||||
|
||||
/* No-one likes lines that are 400 characters long. */
|
||||
div.rst-content {max-width: 54em;}
|
||||
|
||||
.wy-side-nav-search, .wy-nav-top {
|
||||
background-color: var(--sidebar-dark) !important;
|
||||
}
|
||||
.wy-side-nav-search a.icon-home {
|
||||
width: 100%;
|
||||
max-width: 250px;
|
||||
background-size: 100%;
|
||||
}
|
||||
|
||||
a.icon-home:before {
|
||||
display: block;
|
||||
width: 84px;
|
||||
height: 70px;
|
||||
content: "";
|
||||
background: url(../img/logo_white.svg) center center no-repeat;
|
||||
margin: 10px auto;
|
||||
}
|
||||
|
||||
.wy-menu-vertical a, .wy-menu-vertical li ul li a {color: var(--off-white) !important; }
|
||||
|
||||
.wy-menu-vertical a:hover, .wy-menu-vertical li.current a:hover { background-color: transparent !important; color: white !important;}
|
||||
.wy-menu-vertical li.on a, .wy-menu-vertical li.current>a {
|
||||
background: transparent; !important;
|
||||
color: white !important;
|
||||
border: none;
|
||||
position: relative;
|
||||
font-weight: 700 !important;
|
||||
border-right: none !important;
|
||||
}
|
||||
|
||||
.wy-menu-vertical li.on a, .wy-menu-vertical li.current a {
|
||||
border-right: none;
|
||||
}
|
||||
|
||||
.wy-menu-vertical li.on a, .wy-menu-vertical li.current>a:after {
|
||||
display: block;
|
||||
position: absolute;
|
||||
right: 0em;
|
||||
top: 0;
|
||||
z-index: 999 !important;
|
||||
content: "";
|
||||
width: 0;
|
||||
height: 0;
|
||||
border-top: 1em solid transparent;
|
||||
border-bottom: 1em solid transparent;
|
||||
border-right: 1em solid white;
|
||||
}
|
||||
|
||||
.rst-versions, .rst-versions .rst-current-version { background: var(--sidebar); !important; }
|
||||
.wy-menu-vertical span {
|
||||
color: white !important;
|
||||
font-size: 1.2em;
|
||||
font-weight: 300 !important;
|
||||
}
|
||||
.wy-menu-vertical li a {color: var(--off-white) !important; font-weight: 300 !important;}
|
||||
|
||||
|
||||
.wy-nav-side {
|
||||
background: var(--sidebar);
|
||||
font-weight: 300 !important;
|
||||
}
|
||||
|
||||
|
||||
footer {display: none;}
|
||||
|
||||
.wy-side-nav-search input[type=text], form .search-query {
|
||||
background-color: rgba(0,0,0,.1) !important;
|
||||
border: 1px solid rgba(255,255,255,.3);
|
||||
box-shadow: none;
|
||||
margin-bottom: 1em;
|
||||
color: white !important;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
.wy-side-nav-search input[type=text]::placeholder, form .search-query::placeholder {
|
||||
color: var(--off-white) !important;
|
||||
}
|
||||
|
||||
.wy-menu-vertical li.current {
|
||||
background: var(--sidebar) !important;
|
||||
}
|
||||
|
||||
.toctree-l2 a:first-child {display: none;}
|
||||
|
||||
/* ------------------------------------------------------------ */
|
||||
/* Logo: ; */
|
||||
/* ------------------------------------------------------------ */
|
||||
|
||||
.logo {
|
||||
width: 128px;
|
||||
height: 128px;
|
||||
vertical-align: middle;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
/* ------------------------------------------------------------ */
|
||||
/* Code blocks in callouts */
|
||||
/* ------------------------------------------------------------ */
|
||||
|
||||
div.admonition {
|
||||
border-radius: 5px;
|
||||
margin: 1em -1em;
|
||||
}
|
||||
div.admonition p.admonition-title {
|
||||
border-top-left-radius: 5px;
|
||||
border-top-right-radius: 5px;
|
||||
}
|
||||
div.admonition > p {
|
||||
padding: 0em .5em;
|
||||
}
|
||||
|
||||
|
||||
div.admonition div.highlight {
|
||||
background: none !important;
|
||||
}
|
||||
div.admonition div.highlight pre {
|
||||
background-color: rgba(255,255,255,.5) !important;
|
||||
}
|
||||
|
||||
/* ------------------------------------------------------------ */
|
||||
/* Fancy ordered lists. */
|
||||
/* ------------------------------------------------------------ */
|
||||
|
||||
ol {
|
||||
counter-reset:li;
|
||||
margin-left: 0px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ol li {
|
||||
list-style: none !important;
|
||||
margin-bottom: 1.5em;
|
||||
margin-left: 3em !important;
|
||||
}
|
||||
|
||||
ol > li:before {
|
||||
content:counter(li);
|
||||
counter-increment:li;
|
||||
background-color: var(--sidebar);
|
||||
border-radius: 50%;
|
||||
display: block;
|
||||
float: left;
|
||||
margin-left: -3em;
|
||||
margin-top: -.3em;
|
||||
width: 2em;
|
||||
height: 2em;
|
||||
color: var(--sidebar-dark);
|
||||
text-align: center;
|
||||
line-height: 2em;
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
257
docs/conf.py
257
docs/conf.py
|
|
@ -1,257 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# jrnl documentation build configuration file, created by
|
||||
# sphinx-quickstart on Wed Aug 7 13:22:51 2013.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
#
|
||||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import sys, os
|
||||
sys.path.insert(0, os.path.abspath('..'))
|
||||
import jrnl
|
||||
from jrnl import __version__
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc']
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix of source filenames.
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'jrnl'
|
||||
copyright = u'jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = __version__
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = version
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
#today = ''
|
||||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = ['_build']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
#add_function_parentheses = True
|
||||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
#show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'native'
|
||||
|
||||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
#keep_warnings = False
|
||||
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'jrnl'
|
||||
|
||||
# On read the docs, use their standard theme.
|
||||
RTD_NEW_THEME = True
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top
|
||||
# of the sidebar.
|
||||
#html_logo = None
|
||||
|
||||
# The name of an image file (within the static path) to use as favicon of the
|
||||
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||
# pixels large.
|
||||
#html_favicon = None
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
||||
# Custom sidebar templates, maps document names to template names.
|
||||
#html_sidebars = {}
|
||||
|
||||
# Additional templates that should be rendered to pages, maps page names to
|
||||
# template names.
|
||||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
||||
# If true, the index is split into individual pages for each letter.
|
||||
#html_split_index = False
|
||||
|
||||
# If true, links to the reST sources are added to the pages.
|
||||
html_show_sourcelink = False
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
html_show_sphinx = False
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'jrnldoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||
latex_documents = [
|
||||
('index', 'jrnl.tex', u'jrnl Documentation',
|
||||
u'Manuel Ebert', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
# the title page.
|
||||
#latex_logo = None
|
||||
|
||||
# For "manual" documents, if this is true, then toplevel headings are parts,
|
||||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output --------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'jrnl', u'jrnl Documentation',
|
||||
[u'Manuel Ebert'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output ------------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'jrnl', u'jrnl Documentation',
|
||||
u'Manuel Ebert', 'jrnl', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
sys.path.append(os.path.abspath('_themes'))
|
||||
html_theme_path = ['_themes']
|
||||
html_theme = 'jrnl'
|
||||
93
docs/encryption.md
Normal file
93
docs/encryption.md
Normal file
|
|
@ -0,0 +1,93 @@
|
|||
# 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
|
||||
|
||||
``` sh
|
||||
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,
|
||||
|
||||
``` sh
|
||||
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.
|
||||
|
||||
## A note on security
|
||||
|
||||
While jrnl follows best practises, true security is an illusion.
|
||||
Specifically, jrnl will leave traces in your memory and your shell
|
||||
history -- it's meant to keep journals secure in transit, for example
|
||||
when storing it on an
|
||||
[untrusted](http://techcrunch.com/2014/04/09/condoleezza-rice-joins-dropboxs-board/)
|
||||
services such as Dropbox. If you're concerned about security, disable
|
||||
history logging for journal in your `.bashrc`
|
||||
|
||||
``` sh
|
||||
HISTIGNORE="$HISTIGNORE:jrnl *"
|
||||
```
|
||||
|
||||
If you are using zsh instead of bash, you can get the same behaviour
|
||||
adding this to your `zshrc`
|
||||
|
||||
``` sh
|
||||
setopt HIST_IGNORE_SPACE
|
||||
alias jrnl=" jrnl"
|
||||
```
|
||||
|
||||
## Manual decryption
|
||||
|
||||
Should you ever want to decrypt your journal manually, you can do so
|
||||
with any program that supports the AES algorithm in CBC. The key used
|
||||
for encryption is the SHA-256-hash of your password, the IV
|
||||
(initialisation vector) is stored in the first 16 bytes of the encrypted
|
||||
file. The plain text is encoded in UTF-8 and padded according to PKCS\#7
|
||||
before being encrypted. Here's a Python script that you can use to
|
||||
decrypt your journal
|
||||
|
||||
``` python
|
||||
#!/usr/bin/env python3
|
||||
|
||||
import argparse
|
||||
from Crypto.Cipher import AES
|
||||
import getpass
|
||||
import hashlib
|
||||
import sys
|
||||
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("filepath", help="journal file to decrypt")
|
||||
args = parser.parse_args()
|
||||
|
||||
pwd = getpass.getpass()
|
||||
key = hashlib.sha256(pwd.encode('utf-8')).digest()
|
||||
|
||||
with open(args.filepath, 'rb') as f:
|
||||
ciphertext = f.read()
|
||||
|
||||
crypto = AES.new(key, AES.MODE_CBC, ciphertext[:16])
|
||||
plain = crypto.decrypt(ciphertext[16:])
|
||||
plain = plain.strip(plain[-1:])
|
||||
plain = plain.decode("utf-8")
|
||||
print(plain)
|
||||
```
|
||||
|
|
@ -1,47 +0,0 @@
|
|||
.. _encryption:
|
||||
|
||||
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, i.e. ``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.
|
||||
|
||||
A note on security
|
||||
------------------
|
||||
|
||||
While jrnl follows best practices, true security is an illusion. Specifically, jrnl will leave traces in your memory and your shell history -- it's meant to keep journals secure in transit, for example when storing it on an `untrusted <http://techcrunch.com/2014/04/09/condoleezza-rice-joins-dropboxs-board/>`_ services such as Dropbox. If you're concerned about security, disable history logging for journal in your ``.bashrc`` ::
|
||||
|
||||
HISTIGNORE="jrnl *:"
|
||||
|
||||
Manual decryption
|
||||
-----------------
|
||||
|
||||
Should you ever want to decrypt your journal manually, you can do so with any program that supports the AES algorithm in CBC. The key used for encryption is the SHA-256-hash of your password, the IV (initialisation vector) is stored in the first 16 bytes of the encrypted file. The plain text is encoded in UTF-8 and padded according to PKCS#7 before being encrypted. 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:])
|
||||
plain = plain.strip(plain[-1])
|
||||
plain = plain.decode("utf-8")
|
||||
76
docs/export.md
Normal file
76
docs/export.md
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
# Import and Export
|
||||
|
||||
## Tag export
|
||||
|
||||
With
|
||||
|
||||
``` sh
|
||||
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.
|
||||
|
||||
## List of all entries
|
||||
|
||||
``` sh
|
||||
jrnl --short
|
||||
```
|
||||
|
||||
Will only display the date and title of each entry.
|
||||
|
||||
## JSON export
|
||||
|
||||
Can do
|
||||
|
||||
``` sh
|
||||
jrnl --export json
|
||||
```
|
||||
|
||||
Why not create a [beautiful timeline](http://timeline.verite.co/) of
|
||||
your journal?
|
||||
|
||||
## Markdown export
|
||||
|
||||
Use
|
||||
|
||||
``` sh
|
||||
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.
|
||||
|
||||
## Text export
|
||||
|
||||
``` sh
|
||||
jrnl --export text
|
||||
```
|
||||
|
||||
Pretty-prints your entire journal.
|
||||
|
||||
## Export to files
|
||||
|
||||
You can specify the output file of your exported journal using the
|
||||
`-o` argument
|
||||
|
||||
``` sh
|
||||
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
|
||||
|
||||
``` sh
|
||||
jrnl --export json -o my_entries/
|
||||
```
|
||||
|
||||
The contents of `my\_entries/` will then look like this:
|
||||
|
||||
``` output
|
||||
my_entries/
|
||||
|- 2013_06_03_a-beautiful-day.json
|
||||
|- 2013_06_07_dinner-with-gabriel.json
|
||||
|- ...
|
||||
```
|
||||
|
|
@ -1,78 +0,0 @@
|
|||
.. _export:
|
||||
|
||||
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.
|
||||
|
||||
List of all entries
|
||||
-------------------
|
||||
|
||||
::
|
||||
|
||||
jrnl --short
|
||||
|
||||
Will only display the date and title of each entry.
|
||||
|
||||
JSON export
|
||||
-----------
|
||||
|
||||
Can do::
|
||||
|
||||
jrnl --export json
|
||||
|
||||
Why not create a `beautiful timeline <http://timeline.verite.co/>`_ 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.
|
||||
|
||||
Text export
|
||||
-----------
|
||||
|
||||
::
|
||||
|
||||
jrnl --export text
|
||||
|
||||
Pretty-prints your entire journal.
|
||||
|
||||
XML export
|
||||
-----------
|
||||
|
||||
::
|
||||
|
||||
jrnl --export xml
|
||||
|
||||
Why anyone would want to export stuff to XML is beyond me, but here you go.
|
||||
|
||||
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:
|
||||
|
||||
.. code-block:: output
|
||||
|
||||
my_entries/
|
||||
|- 2013_06_03_a-beautiful-day.json
|
||||
|- 2013_06_07_dinner-with-gabriel.json
|
||||
|- ...
|
||||
31
docs/index.md
Normal file
31
docs/index.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# Overview
|
||||
|
||||
## What is jrnl?
|
||||
|
||||
`jrnl` is a simple journal application for
|
||||
your command line. Journals are stored as human readable plain text
|
||||
files - you can put them into a Dropbox folder for instant syncing and
|
||||
you can be assured that your journal will still be readable in 2050,
|
||||
when all your fancy iPad journal applications will long be forgotten.
|
||||
|
||||
`jrnl` also plays nice with the fabulous
|
||||
[DayOne](http://dayoneapp.com) and can read and write directly from and
|
||||
to DayOne Journals.
|
||||
|
||||
Optionally, your journal can be encrypted using the [256-bit
|
||||
AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
|
||||
|
||||
## Why keep a journal?
|
||||
|
||||
Journals aren't just for angsty teenagers and people who have too much
|
||||
time on their summer vacation. A journal helps you to keep track of the
|
||||
things you get done and how you did them. Your imagination may be
|
||||
limitless, but your memory isn't.
|
||||
|
||||
For personal use, make it a good habit to write at least 20 words a day.
|
||||
Just to reflect what made this day special, why you haven't wasted it.
|
||||
|
||||
For professional use, consider a text-based journal to be the perfect
|
||||
complement to your GTD todo list - a documentation of what and how
|
||||
you've done it. Or use it as a quick way to keep a change log. Or use it
|
||||
to keep a lab book.
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
.. jrnl documentation master file, created by
|
||||
sphinx-quickstart on Wed Aug 7 13:22:51 2013.
|
||||
|
||||
jrnl: The command-line journal
|
||||
==============================
|
||||
|
||||
Release v\ |version|.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
overview
|
||||
installation
|
||||
usage
|
||||
encryption
|
||||
export
|
||||
advanced
|
||||
recipes
|
||||
55
docs/installation.md
Normal file
55
docs/installation.md
Normal file
|
|
@ -0,0 +1,55 @@
|
|||
# Getting started
|
||||
|
||||
## Installation
|
||||
|
||||
On OS X, the easiest way to install *jrnl* is using
|
||||
[Homebrew](http://brew.sh/)
|
||||
|
||||
``` sh
|
||||
brew install jrnl
|
||||
```
|
||||
|
||||
On other platforms, install *jrnl* using pip
|
||||
|
||||
``` sh
|
||||
pip install jrnl
|
||||
```
|
||||
|
||||
Or, if you want the option to encrypt your journal,
|
||||
|
||||
``` sh
|
||||
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 PyCrypto manually](https://www.dlitz.net/software/pycrypto/)
|
||||
first or install it with `pip install pycrypto` if you have a `gcc` compiler.
|
||||
Also note that when using zsh, the correct syntax is `pip install "jrnl[encrypted]"` (note the quotes).
|
||||
|
||||
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
|
||||
|
||||
``` sh
|
||||
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:
|
||||
|
||||
``` 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 *jrnl* to use your external editor.
|
||||
|
|
@ -1,35 +0,0 @@
|
|||
.. _download:
|
||||
|
||||
Getting started
|
||||
===============
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Install *jrnl* using pip ::
|
||||
|
||||
pip install jrnl
|
||||
|
||||
Alternatively, on OS X with [Homebrew](http://brew.sh/) installed:
|
||||
|
||||
brew 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::
|
||||
|
||||
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:
|
||||
|
||||
.. code-block:: 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 *jrnl* to use your external editor.
|
||||
|
||||
31
docs/overview.md
Normal file
31
docs/overview.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
# Overview
|
||||
|
||||
## What is jrnl?
|
||||
|
||||
`jrnl` is a simple journal application for
|
||||
your command line. Journals are stored as human readable plain text
|
||||
files - you can put them into a Dropbox folder for instant syncing and
|
||||
you can be assured that your journal will still be readable in 2050,
|
||||
when all your fancy iPad journal applications will long be forgotten.
|
||||
|
||||
`jrnl` also plays nice with the fabulous
|
||||
[DayOne](http://dayoneapp.com) and can read and write directly from and
|
||||
to DayOne Journals.
|
||||
|
||||
Optionally, your journal can be encrypted using the [256-bit
|
||||
AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
|
||||
|
||||
## Why keep a journal?
|
||||
|
||||
Journals aren't just for angsty teenagers and people who have too much
|
||||
time on their summer vacation. A journal helps you to keep track of the
|
||||
things you get done and how you did them. Your imagination may be
|
||||
limitless, but your memory isn't.
|
||||
|
||||
For personal use, make it a good habit to write at least 20 words a day.
|
||||
Just to reflect what made this day special, why you haven't wasted it.
|
||||
|
||||
For professional use, consider a text-based journal to be the perfect
|
||||
complement to your GTD todo list - a documentation of what and how
|
||||
you've done it. Or use it as a quick way to keep a change log. Or use it
|
||||
to keep a lab book.
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
.. _overview:
|
||||
|
||||
Overview
|
||||
===============
|
||||
|
||||
What is jrnl?
|
||||
-------------
|
||||
|
||||
`jrnl` is a simple journal application for your command line. Journals are stored as human readable plain text files - you can put them into a Dropbox folder for instant syncing and you can be assured that your journal will still be readable in 2050, when all your fancy iPad journal applications will long be forgotten.
|
||||
|
||||
`jrnl` also plays nice with the fabulous `DayOne <http://dayoneapp.com>`_ and can read and write directly from and to DayOne Journals.
|
||||
|
||||
Optionally, your journal can be encrypted using the `256-bit AES <http://en.wikipedia.org/wiki/Advanced_Encryption_Standard>`_.
|
||||
|
||||
Why keep a journal?
|
||||
-------------------
|
||||
|
||||
Journals aren't only for 13-year old girls and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't.
|
||||
|
||||
For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it.
|
||||
|
||||
For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it. Or use it as a quick way to keep a change log. Or use it to keep a lab book.
|
||||
|
||||
190
docs/recipes.md
Normal file
190
docs/recipes.md
Normal file
|
|
@ -0,0 +1,190 @@
|
|||
# FAQ
|
||||
|
||||
## Recipes
|
||||
|
||||
### Co-occurrence of tags
|
||||
|
||||
If I want to find out how often I mentioned my flatmates Alberto and
|
||||
Melo in the same entry, I run
|
||||
|
||||
``` sh
|
||||
jrnl @alberto --tags | grep @melo
|
||||
```
|
||||
|
||||
And will get something like `@melo: 9`, meaning there are 9 entries
|
||||
where both `@alberto` and `@melo` are tagged. How does this work? First,
|
||||
`jrnl @alberto` will filter the journal to only entries containing the
|
||||
tag `@alberto`, and then the `--tags` option will print out how often
|
||||
each tag occurred in this <span class="title-ref">filtered</span>
|
||||
journal. Finally, we pipe this to `grep` which will only display the
|
||||
line containing `@melo`.
|
||||
|
||||
### Combining filters
|
||||
|
||||
You can do things like
|
||||
|
||||
``` sh
|
||||
jrnl @fixed -starred -n 10 -until "jan 2013" --short
|
||||
```
|
||||
|
||||
To get a short summary of the 10 most recent, favourited entries before
|
||||
January 1, 2013 that are tagged with `@fixed`.
|
||||
|
||||
### Statistics
|
||||
|
||||
How much did I write last year?
|
||||
|
||||
``` sh
|
||||
jrnl -from "jan 1 2013" -until "dec 31 2013" | wc -w
|
||||
```
|
||||
|
||||
Will give you the number of words you wrote in 2013. How long is my
|
||||
average entry?
|
||||
|
||||
``` sh
|
||||
expr $(jrnl --export text | wc -w) / $(jrnl --short | wc -l)
|
||||
```
|
||||
|
||||
This will first get the total number of words in the journal and divide
|
||||
it by the number of entries (this works because `jrnl --short` will
|
||||
print exactly one line per entry).
|
||||
|
||||
### Importing older files
|
||||
|
||||
If you want to import a file as an entry to jrnl, you can just do `jrnl
|
||||
< entry.ext`. But what if you want the modification date of the file to
|
||||
be the date of the entry in jrnl? Try this
|
||||
|
||||
``` sh
|
||||
echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' entry.txt` `cat entry.txt` | jrnl
|
||||
```
|
||||
|
||||
The first part will format the modification date of `entry.txt`, and
|
||||
then combine it with the contents of the file before piping it to jrnl.
|
||||
If you do that often, consider creating a function in your `.bashrc` or
|
||||
`.bash_profile`
|
||||
|
||||
``` sh
|
||||
jrnlimport () {
|
||||
echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' $1` `cat $1` | jrnl
|
||||
}
|
||||
```
|
||||
|
||||
### Using templates
|
||||
|
||||
Say you always want to use the same template for creating new entries.
|
||||
If you have an `external editor <advanced>` set up, you can use this :
|
||||
|
||||
jrnl < my_template.txt
|
||||
$ jrnl -1 --edit
|
||||
|
||||
Another nice solution that allows you to define individual prompts comes
|
||||
from [Jacobo de
|
||||
Vera](https://github.com/maebert/jrnl/issues/194#issuecomment-47402869):
|
||||
|
||||
``` sh
|
||||
function log_question()
|
||||
{
|
||||
echo $1
|
||||
read
|
||||
jrnl today: ${1}. $REPLY
|
||||
}
|
||||
log_question 'What did I achieve today?'
|
||||
log_question 'What did I make progress with?'
|
||||
```
|
||||
|
||||
## External editors
|
||||
|
||||
To use external editors for writing and editing journal entries, set
|
||||
them up in your `.jrnl_config` (see `advanced usage <advanced>` for
|
||||
details). Generally, after writing an entry, you will have to save and
|
||||
close the file to save the changes to jrnl.
|
||||
|
||||
### Sublime Text
|
||||
|
||||
To use Sublime Text, install the command line tools for Sublime Text and
|
||||
configure your `.jrnl_config` like this:
|
||||
|
||||
``` javascript
|
||||
"editor": "subl -w"
|
||||
```
|
||||
|
||||
Note the `-w` flag to make sure jrnl waits for Sublime Text to close the
|
||||
file before writing into the journal.
|
||||
|
||||
### MacVim
|
||||
|
||||
Similar to Sublime Text, MacVim must be started with a flag that tells
|
||||
the the process to wait until the file is closed before passing control
|
||||
back to journal. In the case of MacVim, this is `-f`:
|
||||
|
||||
``` javascript
|
||||
"editor": "mvim -f"
|
||||
```
|
||||
|
||||
### iA Writer
|
||||
|
||||
On OS X, you can use the fabulous [iA
|
||||
Writer](http://www.iawriter.com/mac) to write entries. Configure your
|
||||
`.jrnl_config` like this:
|
||||
|
||||
``` javascript
|
||||
"editor": "open -b pro.writer.mac -Wn"
|
||||
```
|
||||
|
||||
What does this do? `open -b ...` opens a file using the application
|
||||
identified by the bundle identifier (a unique string for every app out
|
||||
there). `-Wn` tells the application to wait until it's closed before
|
||||
passing back control, and to use a new instance of the application.
|
||||
|
||||
If the `pro.writer.mac` bundle identifier is not found on your system,
|
||||
you can find the right string to use by inspecting iA Writer's
|
||||
`Info.plist` file in your shell:
|
||||
|
||||
``` sh
|
||||
$ grep -A 1 CFBundleIdentifier /Applications/iA\ Writer.app/Contents/Info.plist
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>pro.writer.mac</string>
|
||||
```
|
||||
|
||||
### Notepad++ on Windows
|
||||
|
||||
To set [Notepad++](http://notepad-plus-plus.org/) as your editor, edit
|
||||
the jrnl config file (`.jrnl_config`) like this:
|
||||
|
||||
``` javascript
|
||||
"editor": "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst -nosession",
|
||||
```
|
||||
|
||||
The double backslashes are needed so jrnl can read the file path
|
||||
correctly. The `-multiInst -nosession` options will cause jrnl to open
|
||||
its own Notepad++ window.
|
||||
|
||||
### Visual Studio Code
|
||||
|
||||
To set [Visual Studo Code](https://code.visualstudio.com) as your editor on Linux, edit `.jrnl_config` like this:
|
||||
|
||||
```javascript
|
||||
{
|
||||
"editor": "/usr/bin/code --wait",
|
||||
}
|
||||
```
|
||||
|
||||
The `--wait` argument tells VS Code to wait for files to be written out before handing back control to jrnl.
|
||||
|
||||
On MacOS you will need to add VS Code to your PATH. You can do that by adding:
|
||||
|
||||
```sh
|
||||
export PATH="\$PATH:/Applications/Visual Studio Code.app/Contents/Resources/app/bin"
|
||||
```
|
||||
to your `.bash_profile`, or by running the **Install 'code' command in PATH** command from the command pallet in VS Code.
|
||||
|
||||
Then you can add:
|
||||
|
||||
```javascript
|
||||
{
|
||||
"editor": "code --wait",
|
||||
}
|
||||
```
|
||||
|
||||
to ``.jrnl_config``. See also the [Visual Studio Code documentation](https://code.visualstudio.com/docs/setup/mac)
|
||||
152
docs/recipes.rst
152
docs/recipes.rst
|
|
@ -1,152 +0,0 @@
|
|||
.. _recipes:
|
||||
|
||||
FAQ
|
||||
===
|
||||
|
||||
Recipes
|
||||
-------
|
||||
|
||||
Co-occurrence of tags
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If I want to find out how often I mentioned my flatmates Alberto and Melo in the same entry, I run ::
|
||||
|
||||
jrnl @alberto --tags | grep @melo
|
||||
|
||||
And will get something like ``@melo: 9``, meaning there are 9 entries where both ``@alberto`` and ``@melo`` are tagged. How does this work? First, ``jrnl @alberto`` will filter the journal to only entries containing the tag ``@alberto``, and then the ``--tags`` option will print out how often each tag occurred in this `filtered` journal. Finally, we pipe this to ``grep`` which will only display the line containing ``@melo``.
|
||||
|
||||
Combining filters
|
||||
~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can do things like ::
|
||||
|
||||
jrnl @fixed -starred -n 10 -until "jan 2013" --short
|
||||
|
||||
To get a short summary of the 10 most recent, favourited entries before January 1, 2013 that are tagged with ``@fixed``.
|
||||
|
||||
Statistics
|
||||
~~~~~~~~~~
|
||||
|
||||
How much did I write last year? ::
|
||||
|
||||
jrnl -from "jan 1 2013" -until "dec 31 2013" | wc -w
|
||||
|
||||
Will give you the number of words you wrote in 2013. How long is my average entry? ::
|
||||
|
||||
expr $(jrnl --export text | wc -w) / $(jrnl --short | wc -l)
|
||||
|
||||
This will first get the total number of words in the journal and divide it by the number of entries (this works because ``jrnl --short`` will print exactly one line per entry).
|
||||
|
||||
Importing older files
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If you want to import a file as an entry to jrnl, you can just do ``jrnl < entry.ext``. But what if you want the modification date of the file to be the date of the entry in jrnl? Try this ::
|
||||
|
||||
echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' entry.txt` `cat entry.txt` | jrnl
|
||||
|
||||
The first part will format the modification date of ``entry.txt``, and then combine it with the contents of the file before piping it to jrnl. If you do that often, consider creating a function in your ``.bashrc`` or ``.bash_profile``
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
jrnlimport () {
|
||||
echo `stat -f %Sm -t '%d %b %Y at %H:%M: ' $1` `cat $1` | jrnl
|
||||
}
|
||||
|
||||
|
||||
Using templates
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
Say you always want to use the same template for creating new entries. If you have an :doc:`external editor <advanced>` set up, you can use this ::
|
||||
|
||||
jrnl < my_template.txt
|
||||
$ jrnl -1 --edit
|
||||
|
||||
Another nice solution that allows you to define individual prompts comes from `Jacobo de Vera <https://github.com/maebert/jrnl/issues/194#issuecomment-47402869>`_:
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
function log_question()
|
||||
{
|
||||
echo $1
|
||||
read
|
||||
jrnl today: ${1}. $REPLY
|
||||
}
|
||||
log_question 'What did I achieve today?'
|
||||
log_question 'What did I make progress with?'
|
||||
|
||||
|
||||
External editors
|
||||
----------------
|
||||
|
||||
To use external editors for writing and editing journal entries, set them up in your ``.jrnl_config`` (see :doc:`advanced usage <advanced>` for details). Generally, after writing an entry, you will have to save and close the file to save the changes to jrnl.
|
||||
|
||||
Sublime Text
|
||||
~~~~~~~~~~~~
|
||||
|
||||
To use Sublime Text, install the command line tools for Sublime Text and configure your ``.jrnl_config`` like this:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
"editor": "subl -w"
|
||||
|
||||
Note the ``-w`` flag to make sure jrnl waits for Sublime Text to close the file before writing into the journal.
|
||||
|
||||
|
||||
MacVim
|
||||
~~~~~~
|
||||
|
||||
Similar to Sublime Text, MacVim must be started with a flag that tells the the process to wait until the file is closed before passing control back to journal. In the case of MacVim, this is ``-f``:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
"editor": "mvim -f"
|
||||
|
||||
iA Writer
|
||||
~~~~~~~~~
|
||||
|
||||
On OS X, you can use the fabulous `iA Writer <http://www.iawriter.com/mac>`_ to write entries. Configure your ``.jrnl_config`` like this:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
"editor": "open -b jp.informationarchitects.WriterForMacOSX -Wn"
|
||||
|
||||
What does this do? ``open -b ...`` opens a file using the application identified by the bundle identifier (a unique string for every app out there). ``-Wn`` tells the application to wait until it's closed before passing back control, and to use a new instance of the application.
|
||||
|
||||
|
||||
Notepad++ on Windows
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To set `Notepad++ <http://notepad-plus-plus.org/>`_ as your editor, edit the jrnl config file (``.jrnl_config``) like this:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
"editor": "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst -nosession",
|
||||
|
||||
The double backslashes are needed so jrnl can read the file path correctly. The ``-multiInst -nosession`` options will cause jrnl to open its own Notepad++ window.
|
||||
|
||||
Visual Studio Code
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To set `Visual Studo Code <https://code.visualstudio.com/>`_ as your editor on Linux, edit ``.jrnl_config`` like this:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
"editor": "/usr/bin/code --wait",
|
||||
|
||||
The --wait argument tells VS Code to wait for files to be written out before handing back control to jrnl.
|
||||
|
||||
On MacOS you will need to add VS Code to your PATH. You can do that by adding:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
export PATH="\$PATH:/Applications/Visual Studio Code.app/Contents/Resources/app/bin"
|
||||
|
||||
to your .bash_profile, or by running the **Install 'code' command in PATH** command from the command pallet in VS Code.
|
||||
|
||||
Then you can add:
|
||||
|
||||
.. code-block:: javascript
|
||||
|
||||
"editor": "code --wait",
|
||||
|
||||
to ``.jrnl_config``. See also `the Visual Studio Code documentation <https://code.visualstudio.com/docs/setup/mac>`_.
|
||||
BIN
docs/theme/img/banner_og.png
vendored
Normal file
BIN
docs/theme/img/banner_og.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 224 KiB |
BIN
docs/theme/img/banner_twitter.png
vendored
Normal file
BIN
docs/theme/img/banner_twitter.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 175 KiB |
BIN
docs/theme/img/favicon.ico
vendored
Normal file
BIN
docs/theme/img/favicon.ico
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
15
docs/theme/img/favicon.svg
vendored
Normal file
15
docs/theme/img/favicon.svg
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg width="64px" height="64px" viewBox="0 0 64 64" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<!-- Generator: Sketch 55 (78076) - https://sketchapp.com -->
|
||||
<title>favicon</title>
|
||||
<desc>Created with Sketch.</desc>
|
||||
<defs>
|
||||
<linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
|
||||
<stop stop-color="#986B9D" offset="0%"></stop>
|
||||
<stop stop-color="#664C8B" offset="100%"></stop>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<g id="favicon" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||
<path d="M47,9.75231557 L47,37 L42,32 L37,37 L37,7 L25,7 C17.8202983,7 12,12.8202983 12,20 L12,44 C12,51.1797017 17.8202983,57 25,57 L32,57 L32,7 L34,7 L34,57 L39,57 C46.1797017,57 52,51.1797017 52,44 L52,20 C52,15.8373552 50.0435392,12.1316662 47,9.75231557 Z M47.097641,7.37132944 C51.2495133,10.039075 54,14.6983322 54,20 L54,44 C54,49.3016678 51.2495133,53.960925 47.097641,56.6286706 C52.7817736,55.2392133 57,50.1122164 57,44 L57,20 C57,13.8877836 52.7817736,8.76078667 47.097641,7.37132944 Z M16.902359,56.6286706 C12.7504867,53.960925 10,49.3016678 10,44 L10,20 C10,14.6983322 12.7504867,10.039075 16.902359,7.37132944 C11.2182264,8.76078667 7,13.8877836 7,20 L7,44 C7,50.1122164 11.2182264,55.2392133 16.902359,56.6286706 Z M52.097641,7.37132944 C56.2495133,10.039075 59,14.6983322 59,20 L59,44 C59,49.3016678 56.2495133,53.960925 52.097641,56.6286706 C57.7817736,55.2392133 62,50.1122164 62,44 L62,20 C62,13.8877836 57.7817736,8.76078667 52.097641,7.37132944 Z M11.902359,56.6286706 C7.7504867,53.960925 5,49.3016678 5,44 L5,20 C5,14.6983322 7.7504867,10.039075 11.902359,7.37132944 C6.21822638,8.76078667 2,13.8877836 2,20 L2,44 C2,50.1122164 6.21822638,55.2392133 11.902359,56.6286706 Z M15,5 L49,5 C57.2842712,5 64,11.7157288 64,20 L64,44 C64,52.2842712 57.2842712,59 49,59 L15,59 C6.71572875,59 0,52.2842712 0,44 L0,20 C2.0539126e-15,11.7157288 6.71572875,5 15,5 Z" id="Combined-Shape" fill="url(#linearGradient-1)" fill-rule="nonzero"></path>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.1 KiB |
16
docs/theme/img/logo.svg
vendored
Normal file
16
docs/theme/img/logo.svg
vendored
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg width="90px" height="98px" viewBox="0 0 90 98" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<!-- Generator: Sketch 55 (78076) - https://sketchapp.com -->
|
||||
<title>logo</title>
|
||||
<desc>Created with Sketch.</desc>
|
||||
<defs>
|
||||
<linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
|
||||
<stop stop-color="#986B9D" offset="0%"></stop>
|
||||
<stop stop-color="#664C8B" offset="100%"></stop>
|
||||
</linearGradient>
|
||||
</defs>
|
||||
<g id="logo" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||
<path d="M63,5.34786368 L63,43 L58,38 L53,43 L53,5 L30,5 C22.8202983,5 17,10.8202983 17,18 L17,58 C17,65.1797017 22.8202983,71 30,71 L45,71 L45,5 L47,5 L47,71 L60,71 C67.1797017,71 73,65.1797017 73,58 L73,18 C73,11.8528367 68.7334,6.70219128 63,5.34786368 Z M67.6693542,5.10618565 C72.0593056,7.72299627 75,12.5180801 75,18 L75,58 C75,63.4819199 72.0593056,68.2770037 67.6693542,70.8938143 C74.060623,70.0745197 79,64.6140865 79,58 L79,18 C79,11.3859135 74.060623,5.92548026 67.6693542,5.10618565 Z M22.3306458,70.8938143 C17.9406944,68.2770037 15,63.4819199 15,58 L15,18 C15,12.5180801 17.9406944,7.72299627 22.3306458,5.10618565 C15.939377,5.92548026 11,11.3859135 11,18 L11,58 C11,64.6140865 15.939377,70.0745197 22.3306458,70.8938143 Z M73.6693542,5.10618565 C78.0593056,7.72299627 81,12.5180801 81,18 L81,58 C81,63.4819199 78.0593056,68.2770037 73.6693542,70.8938143 C80.060623,70.0745197 85,64.6140865 85,58 L85,18 C85,11.3859135 80.060623,5.92548026 73.6693542,5.10618565 Z M16.3306458,70.8938143 C11.9406944,68.2770037 9,63.4819199 9,58 L9,18 C9,12.5180801 11.9406944,7.72299627 16.3306458,5.10618565 C9.93937703,5.92548026 5,11.3859135 5,18 L5,58 C5,64.6140865 9.93937703,70.0745197 16.3306458,70.8938143 Z M18,3 L72,3 C80.2842712,3 87,9.71572875 87,18 L87,58 C87,66.2842712 80.2842712,73 72,73 L18,73 C9.71572875,73 3,66.2842712 3,58 L3,18 C3,9.71572875 9.71572875,3 18,3 Z" id="Combined-Shape" fill="url(#linearGradient-1)" fill-rule="nonzero"></path>
|
||||
<path d="M24.22,95.092 C24.0293324,95.092 23.7616684,95.0736668 23.417,95.037 C23.0723316,95.0003332 22.7680013,94.9306672 22.504,94.828 L22.856,92.65 C23.1786683,92.7526672 23.5673311,92.804 24.022,92.804 C24.6380031,92.804 25.0706654,92.6243351 25.32,92.265 C25.5693346,91.9056649 25.694,91.3666703 25.694,90.648 L25.694,82.642 L28.356,82.285 L28.356,90.692 C28.356,92.1880075 28.0003369,93.2953297 27.289,94.014 C26.5776631,94.7326703 25.5546733,95.092 24.22,95.092 Z M41.4,84.892 C41.1799989,84.8186663 40.8756686,84.7416671 40.487,84.661 C40.0983314,84.5803329 39.6473359,84.54 39.134,84.54 C38.8406652,84.54 38.5290017,84.569333 38.199,84.628 C37.8689984,84.686667 37.6380007,84.7379998 37.506,84.782 L37.506,94 L34.844,94 L34.844,83.044 C35.3573359,82.8533324 35.9989962,82.6736675 36.769,82.505 C37.5390039,82.3363325 38.3933286,82.252 39.332,82.252 C39.5080009,82.252 39.7133322,82.2629999 39.948,82.285 C40.1826678,82.3070001 40.4173322,82.3363332 40.652,82.373 C40.8866678,82.4096669 41.1139989,82.4536664 41.334,82.505 C41.5540011,82.5563336 41.7299993,82.6039998 41.862,82.648 L41.4,84.892 Z M46.81,82.868 C47.3233359,82.7213326 47.9906626,82.5820007 48.812,82.45 C49.6333374,82.3179993 50.5426617,82.252 51.54,82.252 C52.4786714,82.252 53.2633302,82.3803321 53.894,82.637 C54.5246698,82.893668 55.0269981,83.2529977 55.401,83.715 C55.7750019,84.1770023 56.0389992,84.7343301 56.193,85.387 C56.3470008,86.0396699 56.424,86.7546628 56.424,87.532 L56.424,94 L53.762,94 L53.762,87.95 C53.762,87.3339969 53.7216671,86.8096688 53.641,86.377 C53.5603329,85.9443312 53.4283342,85.5923347 53.245,85.321 C53.0616658,85.0496653 52.8123349,84.8516673 52.497,84.727 C52.1816651,84.6023327 51.7966689,84.54 51.342,84.54 C51.004665,84.54 50.6526685,84.5619998 50.286,84.606 C49.9193315,84.6500002 49.6480009,84.6866665 49.472,84.716 L49.472,94 L46.81,94 L46.81,82.868 Z M66.784,94.22 C65.991996,94.2053333 65.3356693,94.1173341 64.815,93.956 C64.2943307,93.7946659 63.8800015,93.5636682 63.572,93.263 C63.2639985,92.9623318 63.0476673,92.5883356 62.923,92.141 C62.7983327,91.6936644 62.736,91.1840029 62.736,90.612 L62.736,82.692 L65.398,82.252 L65.398,90.106 C65.398,90.4286683 65.4236664,90.6999989 65.475,90.92 C65.5263336,91.1400011 65.6179993,91.3269992 65.75,91.481 C65.8820007,91.6350008 66.0616655,91.7523329 66.289,91.833 C66.5163345,91.9136671 66.8059982,91.9759998 67.158,92.02 L66.784,94.22 Z" id="jrnl" fill="#674C8B" fill-rule="nonzero"></path>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 4.5 KiB |
9
docs/theme/img/logo_white.svg
vendored
Normal file
9
docs/theme/img/logo_white.svg
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg width="84px" height="70px" viewBox="0 0 84 70" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<!-- Generator: Sketch 55 (78076) - https://sketchapp.com -->
|
||||
<title>logo_white</title>
|
||||
<desc>Created with Sketch.</desc>
|
||||
<g id="logo_white" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||
<path d="M60,2.34786368 L60,40 L55,35 L50,40 L50,2 L27,2 C19.8202983,2 14,7.82029825 14,15 L14,55 C14,62.1797017 19.8202983,68 27,68 L42,68 L42,2 L44,2 L44,68 L57,68 C64.1797017,68 70,62.1797017 70,55 L70,15 C70,8.85283673 65.7334,3.70219128 60,2.34786368 Z M64.6693542,2.10618565 C69.0593056,4.72299627 72,9.51808015 72,15 L72,55 C72,60.4819199 69.0593056,65.2770037 64.6693542,67.8938143 C71.060623,67.0745197 76,61.6140865 76,55 L76,15 C76,8.38591347 71.060623,2.92548026 64.6693542,2.10618565 Z M19.3306458,67.8938143 C14.9406944,65.2770037 12,60.4819199 12,55 L12,15 C12,9.51808015 14.9406944,4.72299627 19.3306458,2.10618565 C12.939377,2.92548026 8,8.38591347 8,15 L8,55 C8,61.6140865 12.939377,67.0745197 19.3306458,67.8938143 Z M70.6693542,2.10618565 C75.0593056,4.72299627 78,9.51808015 78,15 L78,55 C78,60.4819199 75.0593056,65.2770037 70.6693542,67.8938143 C77.060623,67.0745197 82,61.6140865 82,55 L82,15 C82,8.38591347 77.060623,2.92548026 70.6693542,2.10618565 Z M13.3306458,67.8938143 C8.94069436,65.2770037 6,60.4819199 6,55 L6,15 C6,9.51808015 8.94069436,4.72299627 13.3306458,2.10618565 C6.93937703,2.92548026 2,8.38591347 2,15 L2,55 C2,61.6140865 6.93937703,67.0745197 13.3306458,67.8938143 Z M15,0 L69,0 C77.2842712,-1.33226763e-15 84,6.71572875 84,15 L84,55 C84,63.2842712 77.2842712,70 69,70 L15,70 C6.71572875,70 2.66453526e-15,63.2842712 0,55 L0,15 C-8.8817842e-16,6.71572875 6.71572875,1.33226763e-15 15,0 Z" id="Combined-Shape" fill="#FFFFFF" fill-rule="nonzero"></path>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.9 KiB |
23
docs/theme/img/sprites.svg
vendored
Normal file
23
docs/theme/img/sprites.svg
vendored
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<svg width="400px" height="240px" viewBox="0 0 400 240" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<!-- Generator: Sketch 55 (78076) - https://sketchapp.com -->
|
||||
<title>sprites</title>
|
||||
<desc>Created with Sketch.</desc>
|
||||
<g id="sprites" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
|
||||
<path d="M200.001666,7.10542736e-15 C186.746448,7.10542736e-15 176.000667,10.745781 176.000667,24.0009999 C176.000667,28.0531687 177.014042,31.8666609 178.791449,35.2174671 L162.102754,51.9021622 L162.117422,51.9141627 C160.812034,53.1968828 160,54.9729568 160,56.9463723 C160,60.8452014 163.160132,64.0039997 167.057627,64.0039997 C169.028376,64.0039997 170.805783,63.1919658 172.08717,61.8865781 L172.08317,61.882578 L188.765198,45.2018831 C192.117338,46.984624 195.937497,48.0019997 199.999,48.0019997 C213.254219,48.0019997 224,37.2562187 224,24.0009999 C224.002666,10.7471144 213.256885,7.10542736e-15 200.001666,7.10542736e-15 Z M169.589733,59.386474 C168.945706,60.0545018 168.053669,60.4731859 167.057627,60.4731859 C165.108213,60.4731859 163.528147,58.8957869 163.528147,56.9450389 C163.528147,55.9489974 163.948164,55.0596271 164.614859,54.4129335 L164.597525,54.3969328 L180.730197,38.2642607 C182.139589,40.1656733 183.819659,41.8457432 185.718405,43.2604689 L169.589733,59.386474 Z M200.001666,44.0044998 C188.957206,44.0044998 180.000833,35.04546 180.000833,24.0036666 C180.000833,12.9592065 188.957206,4.00283342 200.001666,4.00283342 C211.04346,4.00283342 220.0025,12.9592065 220.0025,24.0036666 C220.0025,35.0467933 211.044793,44.0044998 200.001666,44.0044998 Z M200.001666,10.00175 C200.551023,10.00175 201.001708,10.4497687 201.001708,11.0017917 C201.001708,11.5524813 200.551023,12.0018333 200.001666,12.0018333 C193.37339,12.0018333 188.001166,17.3753905 188.001166,24.0023332 C188.001166,24.5543562 187.553148,25.0023749 187.001125,25.0023749 C186.449102,25.0023749 186.001083,24.5543562 186.001083,24.0023332 C186.001083,16.2686777 192.268011,10.00175 200.001666,10.00175 Z" id="path10" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M42,26 L42,18 C42,8.05733333 33.9426667,0 24,0 C14.0573333,0 6,8.05733333 6,18 L6,26 C2.68533333,26 0,28.6853333 0,32 L0,38 L0,40 L0,44 L0,46 C0,55.9426667 8.05733333,64 18,64 L30,64 C39.9426667,64 48,55.9426667 48,46 L48,44 L48,40 L48,38 L48,32 C48,28.684 45.312,26 42,26 Z M10,18 C10,10.268 16.268,4 24,4 C31.732,4 38,10.268 38,18 L38,26 L34,26 L34,18.004 C34,12.48 29.524,8.004 24,8.004 C18.476,8.004 14,12.48 14,18.004 L14,26 L10,26 L10,18 Z M32,18 L32,18.0066667 L32,26 L16,26 L16,18.004 L16,18 C16,13.5813333 19.5813333,10 24,10 C28.4173333,10 32,13.5826667 32,18 Z M44,38 L44,40 L44,44 L44,46 C44,53.7173333 37.7173333,60 30,60 L18,60 C10.2826667,60 4,53.7173333 4,46 L4,44 L4,40 L4,38 L4,32 C4,30.896 4.896,30 6,30 C7.33466667,30 8.66533333,30 10,30 L38,30 C39.332,30 40.664,30 42,30 C43.1026667,30 44,30.896 44,32 L44,38 Z M24,38 C26.208,38 28,39.7906667 28,42 C28,43.2173333 27.344,45.536 26.668,47.364 C26.1213333,48.84 25.564,49.996 24,49.996 C22.5626667,49.996 21.8786667,48.828 21.3333333,47.344 C20.6666667,45.52 20,43.2133333 20,42 C20,39.7906667 21.792,38 24,38 Z" id="path12" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M56,110.174879 L37.4495142,102.225364 L44.8646072,96.9285223 C41.0009854,92.8572051 35.5547484,90.2992712 29.5,90.2992712 C19.2306123,90.2992712 10.6738014,97.6001925 8.72073517,107.291434 L3.77369603,105.243629 C6.58790907,93.6333303 17.023696,85 29.5,85 C37.336557,85 44.3508342,88.4239389 49.2055642,93.8300944 L56,88.9753644 L56,110.174879 Z M14.1353928,126.072692 C17.9965854,130.142795 23.4452516,132.700729 29.5,132.700729 C39.8082547,132.700729 48.3893574,125.343936 50.2974837,115.594395 L55.2396645,117.709002 C52.4412412,129.342378 41.9945229,138 29.5,138 C21.663443,138 14.6467366,134.576061 9.79443579,129.169906 L3,134.024636 L3,112.823907 L21.5504858,120.773421 L14.1353928,126.072692 Z" id="path6" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M110.666667,136 L110.666667,88 L114.666667,88 L114.666667,136 L124,136 C129.154658,136 133.333333,131.821324 133.333333,126.666667 L133.333333,97.3333333 C133.333333,94.1616732 131.751312,91.3595139 129.333333,89.672919 L129.333333,109.333333 L124,105.333333 L118.666667,109.333333 L118.666667,88 L121.333333,88 L100,88 C94.8453423,88 90.6666667,92.1786757 90.6666667,97.3333333 L90.6666667,126.666667 C90.6666667,131.821324 94.8453423,136 100,136 L110.666667,136 Z M134.130346,88.6638236 C136.127154,90.9949079 137.333333,94.0232615 137.333333,97.3333333 L137.333333,126.666667 C137.333333,129.976739 136.127154,133.005092 134.130346,135.336176 C137.570042,133.9607 140,130.597457 140,126.666667 L140,97.3333333 C140,93.4025432 137.570042,90.0393001 134.130346,88.6638236 Z M89.8696538,135.336176 C87.872846,133.005092 86.6666667,129.976739 86.6666667,126.666667 L86.6666667,97.3333333 C86.6666667,94.0232615 87.872846,90.9949079 89.8696538,88.6638236 C86.4299578,90.0393001 84,93.4025432 84,97.3333333 L84,126.666667 C84,130.597457 86.4299578,133.9607 89.8696538,135.336176 Z M93.3333333,84 L130.666667,84 C138.030463,84 144,89.9695367 144,97.3333333 L144,126.666667 C144,134.030463 138.030463,140 130.666667,140 L93.3333333,140 C85.9695367,140 80,134.030463 80,126.666667 L80,97.3333333 C80,89.9695367 85.9695367,84 93.3333333,84 Z" id="Combined-Shape" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M363.625,2 L363.625,13.625 C363.625,13.625 332.463,13.711 331.708333,47.375 C332.168333,42.2843333 335.715667,22.375 363.625,22.375 L363.625,31.0833333 L384,16.5416667 L363.625,2 Z M328,8.54166667 C323.568,8.54166667 320,12.1096667 320,16.5416667 L320,52.5416667 C320,56.9736667 323.568,60.5416667 328,60.5416667 L369.333333,60.5416667 C373.765333,60.5416667 377.333333,56.9736667 377.333333,52.5416667 L377.333333,29.875 L373.333333,32.5416667 L373.333333,52.5416667 C373.333333,54.7576667 371.549333,56.5416667 369.333333,56.5416667 L328,56.5416667 C325.784,56.5416667 324,54.7576667 324,52.5416667 L324,16.5416667 C324,14.3256667 325.784,12.5416667 328,12.5416667 L344,12.5416667 L353.333333,8.54166667 L328,8.54166667 Z" id="path8" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M272,13 C272.552,13 273,13.448 273,14 C273,14.552 272.549333,15 272,15 C261.345333,15 252,20.608 252,27 C252,27.552 251.552,28 251,28 C250.448,28 250,27.552 250,27 C250,19.412 260.074667,13 272,13 Z M272,3 C254.326667,3 240,13.7453333 240,27 C240,35.2546667 245.557333,42.532 254.016,46.852 C254.016,46.9053333 254,46.9413333 254,47 C254,50.5853333 251.322667,54.4466667 250.144,56.472 C250.146667,56.472 250.148,56.472 250.148,56.472 C250.053333,56.692 250,56.9333333 250,57.188 C250,58.188 250.809333,59 251.812,59 C252,59 252.330667,58.9506667 252.321333,58.972 C258.572,57.948 264.46,52.2053333 265.828,50.5426667 C267.826667,50.836 269.886667,51 272,51 C289.670667,51 304,40.2546667 304,27 C304,13.7453333 289.672,3 272,3 Z M272,47 C270.165333,47 268.284,46.86 266.408,46.5866667 C266.213333,46.5546667 266.02,46.544 265.828,46.544 C264.64,46.544 263.502667,47.072 262.736,48.004 C261.88,49.0466667 259.444,51.372 256.566667,53.0826667 C257.346667,51.292 257.956,49.2866667 257.998667,47.2186667 C258.010667,47.0906667 258.016,46.96 258.016,46.8506667 C258.016,45.3466667 257.174667,43.972 255.836,43.2893333 C248.424,39.504 244,33.4146667 244,27 C244,15.972 256.56,7 272,7 C287.436,7 300,15.972 300,27 C300,38.028 287.438667,47 272,47 Z" id="path16" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M378.790667,165.16 C375.5,161.873333 371.168,160 366.898667,160 C363.297333,160 359.98,161.336 357.558667,163.754667 L347.825333,173.562667 C347.796,173.590667 347.761333,173.609333 347.730667,173.638667 C347.714667,173.654667 347.705333,173.676 347.688,173.690667 L347.692,173.694667 L327.034667,194.512 C326.082667,195.458667 325.392,196.636 325.009333,197.922667 L320.310667,214.938667 C320.305333,214.984 320,216.32 320,217 C320,220.864 323.137333,224 327.008,224 C327.778667,224 329.268,223.632 329.322667,223.624 L346.278667,219.165333 C347.566667,218.784 348.737333,218.088 349.689333,217.133333 L380.216,186.366667 C385.766667,180.812 385.14,171.5 378.790667,165.16 Z M352.028,207.590667 C351.864,205.786667 351.353333,204.017333 350.589333,202.337333 L369.5,183.429333 C370.656,187.081333 370.062667,190.901333 367.528,193.437333 C367.512,193.453333 367.492,193.462667 367.477333,193.48 L367.505333,193.505333 L352.049333,209.085333 C352.049333,208.585333 352.073333,208.097333 352.028,207.590667 Z M349.585333,200.512 C348.84,199.286667 347.990667,198.101333 346.941333,197.053333 C345.72,195.832 344.317333,194.873333 342.853333,194.069333 L361.917333,175.005333 C363.413333,175.669333 364.848,176.616 366.113333,177.881333 C367.196,178.958667 368.030667,180.168 368.674667,181.422667 L349.585333,200.512 Z M340.972,193.124 C339.12,192.378667 337.18,191.952 335.236,191.926667 L350.642667,176.402667 C353,174.102667 356.434667,173.44 359.816,174.278667 L340.972,193.124 Z M328.333333,219.745333 C328.116,219.796 327.438667,219.968 326.977333,220 C325.333333,219.98 324,218.644 324,217 C324.024,216.664 324.157333,216.086667 324.204,215.876 L326.309333,208.248 C328.596,208.186667 331.056,209.076 332.989333,211.014667 C334.953333,212.974667 335.877333,215.482667 335.777333,217.797333 L328.333333,219.745333 Z M337.748,217.274667 C337.7,214.590667 336.608,211.798667 334.404,209.598667 C332.32,207.512 329.592,206.308 326.872,206.2 L328.864,198.985333 C329.008,198.505333 329.294667,198.030667 329.646667,197.617333 C333.658667,194.745333 339.828,195.593333 344.114667,199.884 C348.649333,204.416 349.348,211.056 345.856,215.02 C345.624,215.141333 345.389333,215.257333 345.138667,215.332 L337.748,217.274667 Z M377.381333,183.544 L374.013333,186.938667 C374.013333,186.486667 374.068,186.053333 374.025333,185.590667 C373.673333,181.721333 371.869333,177.978667 368.938667,175.052 C365.68,171.792 361.36,169.921333 357.082667,169.909333 L360.394667,166.569333 C362.054667,164.916 364.368,164 366.898667,164 C370.116,164 373.422667,165.456 375.965333,167.990667 C378.352,170.373333 379.773333,173.332 379.977333,176.326667 C380.164,179.12 379.241333,181.681333 377.381333,183.544 Z" id="path14" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M192,80 C174.326667,80 160,94.3266667 160,112 C160,129.673333 174.326667,144 192,144 C209.673333,144 224,129.673333 224,112 C224,94.3266667 209.673333,80 192,80 Z M192,84 C207.463973,84 220,96.536024 220,112 C220,124.684311 211.56628,135.391332 200,138.833333 L200,137.666667 L200,135.375 L200,132.875 C200,130.353667 199.104333,128.479667 197.375,127.291667 C198.459,127.187667 199.469667,127.061667 200.375,126.875 C201.280333,126.688333 202.239333,126.436667 203.25,126.083333 C204.260667,125.73 205.155667,125.281 205.958333,124.791667 C206.761,124.302333 207.553,123.656333 208.291667,122.875 C209.030333,122.093667 209.625,121.239333 210.125,120.25 C210.625,119.260667 211.041333,118.052 211.333333,116.666667 C211.625333,115.281333 211.75,113.75 211.75,112.083333 C211.75,108.854 210.729,106.105333 208.625,103.833333 C209.583667,101.333333 209.458333,98.604 208.291667,95.6666667 L207.5,95.5833333 C206.958667,95.5206667 205.988667,95.7703333 204.583333,96.2916667 C203.178,96.813 201.625667,97.6453333 199.875,98.8333333 C197.396333,98.1453333 194.791667,97.8333333 192.125,97.8333333 C189.437,97.8333333 186.895667,98.1466667 184.458333,98.8333333 C183.354333,98.0826667 182.322667,97.4906667 181.333333,97 C180.344,96.5106667 179.551667,96.1773333 178.958333,96 C178.365,95.8226667 177.802333,95.708 177.291667,95.6666667 C176.781,95.6253333 176.437,95.6036667 176.291667,95.625 C176.146333,95.6463333 176.061333,95.687 176,95.7083333 C174.833333,98.667 174.708,101.354667 175.666667,103.833333 C173.562667,106.104 172.5,108.854 172.5,112.083333 C172.5,113.75 172.666333,115.281333 172.958333,116.666667 C173.250333,118.052 173.625,119.260667 174.125,120.25 C174.625,121.239333 175.26,122.093667 176,122.875 C176.74,123.656333 177.532,124.301 178.333333,124.791667 C179.134667,125.282333 180.031,125.73 181.041667,126.083333 C182.052333,126.436667 182.678,126.688333 183.583333,126.875 C184.488667,127.061667 185.500667,127.229333 186.583333,127.333333 C184.875333,128.5 184,130.333667 184,132.875 L184,135.125 L184,137.75 L184,138.833333 C172.433733,135.391332 164,124.684311 164,112 C164,96.536024 176.53604,84 192,84 Z" id="path22" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M100,1.0658141e-14 C99.0049467,1.0658141e-14 98.0752267,0.350804013 97.3333333,0.958333333 C96.59144,1.56586265 96,2.50111463 96,3.625 L96,5.33333333 L94.6666667,5.33333333 L94.6666667,6.66666667 L87.3333333,6.66666667 C87.264,6.66305333 87.1943867,6.66305333 87.125,6.66666667 C86.1491067,6.76895307 85.32808,7.6854408 85.3333333,8.66666667 L85.3333333,9.33333333 L83.3333333,9.33333333 C82.28616,9.333438 81.33344,10.2861644 81.3333333,11.3333333 L81.3333333,12.125 C80.5629867,12.3974076 80.0044,13.1829169 80,14 L80,18 C80.0001067,19.0471693 80.9528267,19.9998947 82,20 L85.3333333,20 L85.3333333,53.3333333 L83.6666667,54.9166667 C83.05688,55.268736 82.6604,55.962572 82.6666667,56.6666667 L82.6666667,60.6666667 C82.6667733,61.713836 83.6194933,62.6665613 84.6666667,62.6666667 L95.2083333,62.6666667 L104.666667,62.6666667 L104.875,62.6666667 L115.333333,62.6666667 C116.380507,62.6665613 117.333227,61.713836 117.333333,60.6666667 L117.333333,56.6666667 C117.34,55.962572 116.94312,55.268736 116.333333,54.9166667 L114.666667,53.3333333 L114.666667,20 L118,20 C119.047173,19.9998947 119.999893,19.0471693 120,18 L120,14 C119.996,13.1829169 119.437013,12.3974076 118.666667,12.125 L118.666667,11.3333333 C118.66656,10.2861644 117.71384,9.333438 116.666667,9.33333333 L114.666667,9.33333333 L114.666667,8.66666667 C114.66656,7.61949773 113.71384,6.66677133 112.666667,6.66666667 L105.333333,6.66666667 L105.333333,5.33333333 L104,5.33333333 L104,3.625 C104,2.50111463 103.40856,1.56586269 102.666667,0.958333333 C101.924773,0.350803973 100.995053,1.0658141e-14 100,1.0658141e-14 Z M100,2.66666667 C100.274467,2.66666667 100.684267,2.8172396 100.958333,3.04166667 C101.2324,3.26609373 101.333333,3.4793628 101.333333,3.625 L101.333333,5.33333333 L98.6666667,5.33333333 L98.6666667,3.625 C98.6666667,3.4793628 98.7676,3.2660936 99.0416667,3.04166667 C99.3157333,2.81723973 99.7255333,2.66666667 100,2.66666667 Z M88,10.6666667 L112,10.6666667 L112,12 L114.666667,12 C114.596267,12.9827864 114.819853,13.6843969 116,13.4166667 L116,17.3333333 L110.666667,17.3333333 L89.3333333,17.3333333 L84,17.3333333 L84,13.5416667 C85.09188,13.6062785 85.25424,12.8356391 85.3333333,12 L88,12 L88,10.6666667 Z M89.3333333,20 L110.666667,20 L110.666667,56 L113.333333,57.8333333 L113.333333,58.6666667 L86.6666667,58.6666667 L86.6666667,57.8333333 L89.3333333,56 L89.3333333,20 Z M92,22.6666667 L92,28 L94.6666667,28 L94.6666667,22.6666667 L92,22.6666667 Z M96,22.6666667 L96,28 L98.6666667,28 L98.6666667,22.6666667 L96,22.6666667 Z M101.333333,22.6666667 L101.333333,28 L104,28 L104,22.6666667 L101.333333,22.6666667 Z M105.333333,22.6666667 L105.333333,28 L108,28 L108,22.6666667 L105.333333,22.6666667 Z M92,29.3333333 L92,34.6666667 L94.6666667,34.6666667 L94.6666667,29.3333333 L92,29.3333333 Z M96,29.3333333 L96,34.6666667 L98.6666667,34.6666667 L98.6666667,29.3333333 L96,29.3333333 Z M101.333333,29.3333333 L101.333333,34.6666667 L104,34.6666667 L104,29.3333333 L101.333333,29.3333333 Z M105.333333,29.3333333 L105.333333,34.6666667 L108,34.6666667 L108,29.3333333 L105.333333,29.3333333 Z M103.166667,40.8333333 C102.15268,40.8333333 101.333333,41.6526813 101.333333,42.6666667 C101.333333,43.680652 102.15268,44.5 103.166667,44.5 C104.180653,44.5 105,43.680652 105,42.6666667 C105,41.6526813 104.180653,40.8333333 103.166667,40.8333333 Z" id="path3858" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M247.471598,80 L243.471598,115.791667 L247.429931,116.208333 L251.013264,84 L291.929931,84 L295.513264,116.208333 L299.471598,115.791667 L295.471598,80 L247.471598,80 Z M255.471598,88 L255.471598,92 L287.471598,92 L287.471598,88 L255.471598,88 Z M255.471598,96 L255.471598,100 L287.471598,100 L287.471598,96 L255.471598,96 Z M255.471598,104 L255.471598,108 L287.471598,108 L287.471598,104 L255.471598,104 Z M255.471598,112 L255.471598,116 L287.471598,116 L287.471598,112 L255.471598,112 Z M241.471598,120 C240.371598,120 239.748598,120.872667 240.096598,121.916667 L246.846598,142.083333 C247.194598,143.127333 248.371598,144 249.471598,144 L293.471598,144 C294.571598,144 295.748598,143.127333 296.096598,142.083333 L302.846598,121.916667 C303.195931,120.872667 302.571598,120 301.471598,120 L241.471598,120 Z M263.471598,124 L279.471598,124 L279.471598,128 L263.471598,128 L263.471598,124 Z" id="path20" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M344.096,113.921333 C343.74,114.436 343.305333,115.724 342.792,116.038667 C342.277333,116.352 341.697333,116.573333 341.053333,116.694667 C340.406667,116.818667 339.738667,116.873333 339.049333,116.852 L339.049333,119.905333 L343.982667,119.905333 L343.984,132 L347.966667,132 L347.966667,112.008 L344.798667,112.008 C344.685333,112.770667 344.452,113.408 344.096,113.921333 Z M366,96 L370,96 C371.106667,96 372,95.104 372,94 L372,82 C372,80.896 371.106667,80 370,80 L366,80 C364.893333,80 364,80.896 364,82 L364,94 C364,95.104 364.893333,96 366,96 Z M334,96 L338,96 C339.104,96 340,95.104 340,94 L340,82 C340,80.896 339.104,80 338,80 L334,80 C332.896,80 332,80.896 332,82 L332,94 C332,95.104 332.896,96 334,96 Z M380,88 L376,88 L376,98 C376,99.104 375.106667,100 374,100 L362,100 C360.893333,100 360,99.104 360,98 L360,88 L344,88 L344,98 C344,99.104 343.104,100 342,100 L330,100 C328.896,100 328,99.104 328,98 L328,88 L324,88 C321.792,88 320,89.792 320,92 L320,140 C320,142.208 321.792,144 324,144 L380,144 C382.208,144 384,142.208 384,140 L384,92 C384,89.792 382.208,88 380,88 Z M380,138 C380,139.106667 379.106667,140 378,140 L326,140 C324.896,140 324,139.106667 324,138 L324,106 C324,104.896 324.896,104 326,104 L378,104 C379.106667,104 380,104.896 380,106 L380,138 Z M351.969333,115.964 L361.905333,115.964 C360.033333,118.268 358.526667,120.614667 357.376,123.374667 C356.226667,126.136 356.1,129.010667 355.878667,131.998667 L360.14,131.998667 C360.157333,130.666667 359.750667,129.228 360.038667,127.686667 C360.330667,126.144 360.742667,124.622667 361.272,123.116 C361.806667,121.612 362.468,120.193333 363.264,118.862667 C364.056,117.528 364.970667,116.404 365.997333,115.490667 L365.997333,112.006667 L351.968,112.006667 L351.968,115.964 L351.969333,115.964 Z" id="path24" fill="#D9D7DC" fill-rule="nonzero"></path>
|
||||
<path d="M304,173.150807 C301.644441,174.194574 299.116959,174.902444 296.461373,175.218471 C299.172907,173.59473 301.248518,171.019248 302.232259,167.959792 C299.688777,169.463481 296.881243,170.555352 293.889761,171.147249 C291.494254,168.591741 288.086876,167 284.307523,167 C277.056897,167 271.177986,172.878912 271.177986,180.125564 C271.177986,181.15333 271.29396,182.157149 271.51796,183.117046 C260.608034,182.569071 250.933874,177.342082 244.459092,169.399481 C243.327273,171.33517 242.683403,173.590651 242.683403,175.998289 C242.683403,180.553486 245.002989,184.572735 248.522367,186.924216 C246.370729,186.852268 244.347092,186.260371 242.575481,185.276527 L242.575481,185.440501 C242.575481,191.799308 247.102652,197.106298 253.105485,198.314143 C252.005667,198.610091 250.845926,198.774065 249.646133,198.774065 C248.798341,198.774065 247.978471,198.690091 247.1746,198.530091 C248.846237,203.749132 253.693408,207.54438 259.436372,207.648432 C254.945175,211.167811 249.282211,213.259422 243.131404,213.259422 C242.071637,213.259422 241.027766,213.195422 240,213.079448 C245.810938,216.8108 252.709668,218.986386 260.124268,218.986386 C284.275732,218.986386 297.477323,198.982065 297.477323,181.633331 L297.433296,179.933668 C300.012752,178.093874 302.244285,175.782341 304,173.150807 Z" id="Path" fill="#716087" fill-rule="nonzero"></path>
|
||||
<path d="M112,224 C94.326888,224 80,209.673112 80,192 C80,174.326888 94.326888,160 112,160 C129.673112,160 144,174.326888 144,192 C144,209.673112 129.673112,224 112,224 Z M106.2,175.4 C105.853808,175.140356 105.43274,175 105,175 C103.895431,175 103,175.895431 103,177 L103,208 C103,208.43274 103.140356,208.853808 103.4,209.2 C104.062742,210.083656 105.316344,210.262742 106.2,209.6 L126.866667,194.1 C127.018278,193.986292 127.152958,193.851611 127.266667,193.7 C127.929408,192.816344 127.750322,191.562742 126.866667,190.9 L106.2,175.4 Z" id="Combined-Shape" fill="#BFB9C8"></path>
|
||||
<path d="M32,224 C14.326888,224 0,209.673112 0,192 C0,174.326888 14.326888,160 32,160 C49.673112,160 64,174.326888 64,192 C64,209.673112 49.673112,224 32,224 Z M26.2,175.4 C25.8538077,175.140356 25.4327404,175 25,175 C23.8954305,175 23,175.895431 23,177 L23,208 C23,208.43274 23.1403557,208.853808 23.4,209.2 C24.0627417,210.083656 25.3163444,210.262742 26.2,209.6 L46.8666667,194.1 C47.018278,193.986292 47.1529582,193.851611 47.2666667,193.7 C47.9294084,192.816344 47.7503223,191.562742 46.8666667,190.9 L26.2,175.4 Z" id="Combined-Shape-Copy" fill="#BFB9C8" transform="translate(32.000000, 192.000000) scale(-1, 1) translate(-32.000000, -192.000000) "></path>
|
||||
<path d="M192,224 C174.326888,224 160,209.673112 160,192 C160,174.326888 174.326888,160 192,160 C209.673112,160 224,174.326888 224,192 C224,209.673112 209.673112,224 192,224 Z M196,208 L196,186 L184,186 C182.895431,186 182,186.895431 182,188 C182,189.104569 182.895431,190 184,190 L188,190 L188,208 L182,208 C180.895431,208 180,208.895431 180,210 C180,211.104569 180.895431,212 182,212 L202,212 C203.104569,212 204,211.104569 204,210 C204,208.895431 203.104569,208 202,208 L196,208 Z M191,182 C193.761424,182 196,179.761424 196,177 C196,174.238576 193.761424,172 191,172 C188.238576,172 186,174.238576 186,177 C186,179.761424 188.238576,182 191,182 Z" id="Combined-Shape" fill="#BFB9C8"></path>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 22 KiB |
404
docs/theme/index.css
vendored
Normal file
404
docs/theme/index.css
vendored
Normal file
|
|
@ -0,0 +1,404 @@
|
|||
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}audio,canvas,video{display:inline-block}audio:not([controls]){display:none;height:0}[hidden]{display:none}html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}a:focus{outline:thin dotted}a:active,a:hover{outline:0}h1{font-size:2em;margin:.67em 0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}mark{background:#ff0;color:#000}code,kbd,pre,samp{font-family:monospace,serif;font-size:1em}pre{white-space:pre-wrap}q{quotes:"\201C" "\201D" "\2018" "\2019"}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:0}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}button,input{line-height:normal}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}textarea{overflow:auto;vertical-align:top}table{border-collapse:collapse;border-spacing:0}
|
||||
|
||||
.icon {
|
||||
background-image: url("img/sprites.svg");
|
||||
width: 32px;
|
||||
height: 32px;
|
||||
display: inline-block;
|
||||
font-size: 40px;
|
||||
background-size: 200px 120px;
|
||||
}
|
||||
|
||||
h3 { font-weight: 300; }
|
||||
|
||||
.icon.secure {
|
||||
background-position: 0em 0em;
|
||||
}
|
||||
|
||||
.icon.future {
|
||||
background-position: -1em 0em;
|
||||
}
|
||||
|
||||
.icon.search {
|
||||
background-position: -2em 0em;
|
||||
}
|
||||
|
||||
.icon.nli {
|
||||
background-position: -3em 0em;
|
||||
}
|
||||
|
||||
.icon.share {
|
||||
background-position: 0em -1em;
|
||||
}
|
||||
|
||||
.icon.sync {
|
||||
background-position: 0em -1em;
|
||||
}
|
||||
|
||||
.icon.dayone {
|
||||
background-position: -1em -1em;
|
||||
}
|
||||
|
||||
.icon.github {
|
||||
background-position: -2em -1em;
|
||||
}
|
||||
|
||||
.icon.folders {
|
||||
background-position: -3em -1em;
|
||||
}
|
||||
|
||||
.icon.cal {
|
||||
background-position: -4em -1em;
|
||||
}
|
||||
|
||||
.icon.left {
|
||||
background-position: 0em -2em;
|
||||
}
|
||||
|
||||
.icon.right {
|
||||
background-position: -1em -2em;
|
||||
}
|
||||
|
||||
.icon.info {
|
||||
background-position: -2em -2em;
|
||||
}
|
||||
|
||||
.icon.twitter {
|
||||
background-position: -3em -2em;
|
||||
}
|
||||
|
||||
.pre-block {
|
||||
background: #2f1e34;
|
||||
border-radius: 6px;
|
||||
padding: 1px 20px;
|
||||
margin: 40px auto;
|
||||
width: 500px;
|
||||
box-shadow: 0px 1px 8px #a0acb7;
|
||||
position: relative;
|
||||
color: #f7f8f9;
|
||||
font-family: "Monaco", "Courier New";
|
||||
font-size: 12pt;
|
||||
}
|
||||
|
||||
.pre-block #args {
|
||||
color: #f6f7b9;
|
||||
}
|
||||
|
||||
.pre-block #output {
|
||||
color: #9278b5;
|
||||
}
|
||||
|
||||
.terminal {
|
||||
background: #2f1e34;
|
||||
border-radius: 6px;
|
||||
padding: 1px 20px;
|
||||
margin: 40px auto;
|
||||
width: 500px;
|
||||
box-shadow: 0px 1px 8px #a0acb7;
|
||||
position: relative;
|
||||
color: #f7f8f9;
|
||||
font-family: "Monaco", "Courier New";
|
||||
font-size: 12pt;
|
||||
padding: 50px 20px 10px 20px;
|
||||
}
|
||||
|
||||
.terminal #args {
|
||||
color: #f6f7b9;
|
||||
}
|
||||
|
||||
.terminal #output {
|
||||
color: #9278b5;
|
||||
}
|
||||
|
||||
.terminal: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;
|
||||
text-align: center;
|
||||
height: 30px;
|
||||
line-height: 30px;
|
||||
color: #777;
|
||||
text-shadow: 0px 1px 0px #ddd;
|
||||
border-radius: 5px 5px 0px 0px;
|
||||
background: linear-gradient(180deg, #eaeaea 0%, #bababa 100%);
|
||||
}
|
||||
|
||||
body
|
||||
{
|
||||
background-color: #47375d;
|
||||
font-family: "Open Sans", "Helvetica Neue", sans-serif;
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
#twitter {
|
||||
display: block;
|
||||
position: absolute;
|
||||
text-decoration: none;
|
||||
top: 20px;
|
||||
right: 20px;
|
||||
border: 1px solid #47375d;
|
||||
padding: 5px 10px;
|
||||
color: #47375d;
|
||||
border-radius: 3px;
|
||||
opacity: .7;
|
||||
}
|
||||
|
||||
#twitter .icon {
|
||||
transform: scale(.5);
|
||||
vertical-align: -18%;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
#twitter:hover,
|
||||
#twitter:active {
|
||||
opacity: 1;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
#title,
|
||||
#prompt {
|
||||
width: 900px;
|
||||
margin: 0px auto;
|
||||
}
|
||||
|
||||
#upper {
|
||||
*zoom: 1;
|
||||
background: #f7f8f9;
|
||||
box-shadow: inset 0px -6px 6px -3px #dadfe3;
|
||||
}
|
||||
|
||||
#upper:before,
|
||||
#upper:after {
|
||||
content: " ";
|
||||
display: table;
|
||||
}
|
||||
|
||||
#upper:after {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
#upper #title {
|
||||
width: 650px;
|
||||
margin: 150px auto 75px auto;
|
||||
}
|
||||
|
||||
#upper img {
|
||||
float: left;
|
||||
margin-right: 30px;
|
||||
}
|
||||
|
||||
#upper h1 {
|
||||
color: #564371;
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
#upper #prompt {
|
||||
width: 640px;
|
||||
margin: 0 auto;
|
||||
*zoom: 1;
|
||||
}
|
||||
|
||||
#upper #prompt:before,
|
||||
#upper #prompt:after {
|
||||
content: " ";
|
||||
display: table;
|
||||
}
|
||||
|
||||
#upper #prompt:after {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
#upper .terminal {
|
||||
border-radius: 6px 6px 0px 0px;
|
||||
float: left;
|
||||
margin: 0px;
|
||||
width: 500px;
|
||||
min-height: 134px;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
#upper .pleft,
|
||||
#upper .pright {
|
||||
text-align: center;
|
||||
box-sizing: border-box;
|
||||
float: left;
|
||||
padding-top: 50px;
|
||||
width: 70px;
|
||||
}
|
||||
|
||||
#upper .pleft i,
|
||||
#upper .pright i {
|
||||
opacity: .6;
|
||||
}
|
||||
|
||||
#upper .pleft i:hover,
|
||||
#upper .pright i:hover {
|
||||
opacity: 1;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
#nav {
|
||||
background: linear-gradient(180deg, #7c95ca 0%, #5e7dc5 100%);
|
||||
height: 60px;
|
||||
box-shadow: 0px 6px 6px -3px #413155;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
#nav a#twitter-nav {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#nav a {
|
||||
color: #f7f8f9;
|
||||
text-shadow: 0px -1px 0px #253865;
|
||||
text-decoration: none;
|
||||
font-size: 14pt;
|
||||
line-height: 60px;
|
||||
margin: 0 40px;
|
||||
}
|
||||
|
||||
#nav a:hover {
|
||||
color: #f8d055;
|
||||
text-shadow: 0px -1px 0px #947206;
|
||||
}
|
||||
|
||||
#nav a.cta {
|
||||
background: linear-gradient(180deg, #725794 0%, #564371 100%);
|
||||
box-shadow: 0px 1px 0px #413155;
|
||||
border-radius: 5px;
|
||||
padding: 6px 10px 5px 10px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
#nav a.cta:hover {
|
||||
background: linear-gradient(180deg, #f6c324 0%, #c59708 100%);
|
||||
box-shadow: 0px 1px 0px #947206;
|
||||
text-shadow: 0px -1px 0px #947206;
|
||||
color: #f7f8f9;
|
||||
}
|
||||
|
||||
#lower {
|
||||
color: #f7f8f9;
|
||||
max-width: 920px;
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
#lower a {
|
||||
color: #deaa09;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
#lower a:hover {
|
||||
color: #f8d055;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.flex {
|
||||
display: flex;
|
||||
margin: 0 10px;
|
||||
}
|
||||
|
||||
.flex .item {
|
||||
margin: 10px 5px;
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.flex .item:first-child {
|
||||
margin-left: 0px;
|
||||
}
|
||||
.flex .item:last-child {
|
||||
margin-right: 0px;
|
||||
}
|
||||
|
||||
|
||||
.flex .item i {
|
||||
position: absolute;
|
||||
left: 0;
|
||||
top: 16px;
|
||||
}
|
||||
|
||||
.flex .item h3, p {
|
||||
padding-left: 40px;
|
||||
}
|
||||
|
||||
.flex .item h3 {
|
||||
font-size: 12pt;
|
||||
margin-bottom: .5em;
|
||||
}
|
||||
|
||||
.flex .item p {
|
||||
font-size: 10pt;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.flex.lower {
|
||||
opacity: .8;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 680px) {
|
||||
.flex {
|
||||
display: block;
|
||||
}
|
||||
.flex .item {
|
||||
margin: 40px 20px !important;
|
||||
}
|
||||
|
||||
.flex .item h3, p {
|
||||
padding-left: 48px;
|
||||
}
|
||||
|
||||
#nav {
|
||||
height: auto;
|
||||
padding-bottom: 10px;
|
||||
}
|
||||
|
||||
#nav a,
|
||||
#nav a#twitter-nav {
|
||||
display: block;
|
||||
}
|
||||
|
||||
#nav a.cta {
|
||||
margin: 10px;
|
||||
padding: 1px;
|
||||
}
|
||||
|
||||
#upper #twitter {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#upper #title {
|
||||
margin: 30px 0 10px 0;
|
||||
}
|
||||
|
||||
#upper #logo {
|
||||
backgound: red;
|
||||
display: block;
|
||||
float: none;
|
||||
margin: 0px auto;
|
||||
}
|
||||
|
||||
#upper #title br {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#upper .pleft,
|
||||
#upper .pright {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#upper #prompt,
|
||||
#upper #title {
|
||||
width: 100%;
|
||||
box-sizing: border-box;
|
||||
padding: 0px 20px;
|
||||
}
|
||||
|
||||
#upper .terminal {
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
109
docs/theme/index.js
vendored
Normal file
109
docs/theme/index.js
vendored
Normal file
|
|
@ -0,0 +1,109 @@
|
|||
var phrases = [
|
||||
["", "today: Started writing my memoirs. On the command line. Like a boss.", ""],
|
||||
["", "yesterday 2pm: used jrnl to keep track of accomplished tasks. The done.txt for my todo.txt", ""],
|
||||
["-from 2009 -until may", "", "(Displays all entries from January 2009 to last may)"],
|
||||
["", "A day on the beach with @beth and @frank. Taggidy-tag-tag.", ""],
|
||||
["--tags", "", "@idea 7<br />@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);
|
||||
181
docs/usage.md
Normal file
181
docs/usage.md
Normal file
|
|
@ -0,0 +1,181 @@
|
|||
# Basic Usage
|
||||
|
||||
`jrnl` has two modes: **composing** and **viewing**. Basically, whenever
|
||||
you *don't* supply any arguments that start
|
||||
with a dash or double-dash, you're in composing mode, meaning you can
|
||||
write your entry on the command line or an editor of your choice.
|
||||
|
||||
We intentionally break a convention on command line arguments: all
|
||||
arguments starting with a *single dash*
|
||||
will *filter* your journal before viewing
|
||||
it, and can be combined arbitrarily. Arguments with a
|
||||
*double dash* will control how your journal
|
||||
is displayed or exported and are mutually exclusive (ie. you can only
|
||||
specify one way to display or export your journal at a time).
|
||||
|
||||
## Listing Journals
|
||||
|
||||
You can list the journals accessible by jrnl
|
||||
|
||||
``` sh
|
||||
jrnl -ls
|
||||
```
|
||||
|
||||
The journals displayed correspond to those specified in the jrnl
|
||||
configuration file.
|
||||
|
||||
## Composing Entries
|
||||
|
||||
Composing mode is entered by either starting `jrnl` without any
|
||||
arguments -- which will prompt you to write an entry or launch your
|
||||
editor -- or by just writing an entry on the prompt, such as
|
||||
|
||||
``` sh
|
||||
jrnl today at 3am: I just met Steve Buscemi in a bar! He looked funny.
|
||||
```
|
||||
|
||||
!!! note
|
||||
Most shell contains a certain number of reserved characters, such as `#`
|
||||
and `*`. Unbalanced quotes, parenthesis, and so on will also get into
|
||||
the way of your editing. For writing longer entries, just enter `jrnl`
|
||||
and hit `return`. Only then enter the text of your journal entry.
|
||||
Alternatively, `use an external editor <advanced>`).
|
||||
|
||||
You can also import an entry directly from a file
|
||||
|
||||
``` sh
|
||||
jrnl < my_entry.txt
|
||||
```
|
||||
|
||||
### Smart timestamps
|
||||
|
||||
Timestamps that work:
|
||||
|
||||
- at 6am
|
||||
- yesterday
|
||||
- last monday
|
||||
- sunday at noon
|
||||
- 2 march 2012
|
||||
- 7 apr
|
||||
- 5/20/1998 at 23:42
|
||||
|
||||
### Starring entries
|
||||
|
||||
To mark an entry as a favourite, simply "star" it
|
||||
|
||||
``` sh
|
||||
jrnl last sunday *: Best day of my life.
|
||||
```
|
||||
|
||||
If you don't want to add a date (ie. your entry will be dated as now),
|
||||
The following options are equivalent:
|
||||
|
||||
- `jrnl *: Best day of my life.`
|
||||
- `jrnl *Best day of my life.`
|
||||
- `jrnl Best day of my life.*`
|
||||
|
||||
!!! note
|
||||
Just make sure that the asterisk sign is **not** surrounded by
|
||||
whitespaces, e.g. `jrnl Best day of my life! *` will **not** work (the
|
||||
reason being that the `*` sign has a special meaning on most shells).
|
||||
|
||||
## Viewing
|
||||
|
||||
``` sh
|
||||
jrnl -n 10
|
||||
```
|
||||
|
||||
will list you the ten latest entries (if you're lazy, `jrnl -10` will do
|
||||
the same),
|
||||
|
||||
``` sh
|
||||
jrnl -from "last year" -until march
|
||||
```
|
||||
|
||||
everything that happened from the start of last year to the start of
|
||||
last march. To only see your favourite entries, use
|
||||
|
||||
``` sh
|
||||
jrnl -starred
|
||||
```
|
||||
|
||||
## Using Tags
|
||||
|
||||
Keep track of people, projects or locations, by tagging them with an `@`
|
||||
in your entries
|
||||
|
||||
``` sh
|
||||
jrnl Had a wonderful day on the @beach with @Tom and @Anna.
|
||||
```
|
||||
|
||||
You can filter your journal entries just like this:
|
||||
|
||||
``` sh
|
||||
jrnl @pinkie @WorldDomination
|
||||
```
|
||||
|
||||
Will print all entries in which either `@pinkie` or `@WorldDomination`
|
||||
occurred.
|
||||
|
||||
``` sh
|
||||
jrnl -n 5 -and @pineapple @lubricant
|
||||
```
|
||||
|
||||
the last five entries containing both `@pineapple` **and** `@lubricant`.
|
||||
You can change which symbols you'd like to use for tagging in the
|
||||
configuration.
|
||||
|
||||
!!! note
|
||||
`jrnl @pinkie @WorldDomination` will switch to viewing mode because
|
||||
although **no** command line arguments are given, all the input strings
|
||||
look like tags - *jrnl* will assume you want to filter by tag.
|
||||
|
||||
## Editing older entries
|
||||
|
||||
You can edit selected entries after you wrote them. This is particularly
|
||||
useful when your journal file is encrypted or if you're using a DayOne
|
||||
journal. To use this feature, you need to have an editor configured in
|
||||
your journal configuration file (see `advanced usage <advanced>`)
|
||||
|
||||
``` sh
|
||||
jrnl -until 1950 @texas -and @history --edit
|
||||
```
|
||||
|
||||
Will open your editor with all entries tagged with `@texas` and
|
||||
`@history` before 1950. You can make any changes to them you want; after
|
||||
you save the file and close the editor, your journal will be updated.
|
||||
|
||||
Of course, if you are using multiple journals, you can also edit e.g.
|
||||
the latest entry of your work journal with `jrnl work -n 1 --edit`. In
|
||||
any case, this will bring up your editor and save (and, if applicable,
|
||||
encrypt) your edited journal after you save and exit the editor.
|
||||
|
||||
You can also use this feature for deleting entries from your journal
|
||||
|
||||
``` sh
|
||||
jrnl @girlfriend -until 'june 2012' --edit
|
||||
```
|
||||
|
||||
Just select all text, press delete, and everything is gone...
|
||||
|
||||
### Editing DayOne Journals
|
||||
|
||||
DayOne journals can be edited exactly the same way, however the output
|
||||
looks a little bit different because of the way DayOne stores its
|
||||
entries:
|
||||
|
||||
``` output
|
||||
# af8dbd0d43fb55458f11aad586ea2abf
|
||||
2013-05-02 15:30 I told everyone I built my @robot wife for sex.
|
||||
But late at night when we're alone we mostly play Battleship.
|
||||
|
||||
# 2391048fe24111e1983ed49a20be6f9e
|
||||
2013-08-10 03:22 I had all kinds of plans in case of a @zombie attack.
|
||||
I just figured I'd be on the other side.
|
||||
```
|
||||
|
||||
The long strings starting with hash symbol are the so-called UUIDs,
|
||||
unique identifiers for each entry. Don't touch them. If you do, then the
|
||||
old entry would get deleted and a new one written, which means that you
|
||||
could lose DayOne data that jrnl can't handle (such as as the entry's
|
||||
geolocation).
|
||||
134
docs/usage.rst
134
docs/usage.rst
|
|
@ -1,134 +0,0 @@
|
|||
.. _usage:
|
||||
|
||||
Basic Usage
|
||||
===========
|
||||
|
||||
*jrnl* has two modes: **composing** and **viewing**. Basically, whenever you `don't` supply any arguments that start with a dash or double-dash, you're in composing mode, meaning you can write your entry on the command line or an editor of your choice.
|
||||
|
||||
We intentionally break a convention on command line arguments: all arguments starting with a `single dash` will `filter` your journal before viewing it, and can be combined arbitrarily. Arguments with a `double dash` will control how your journal is displayed or exported and are mutually exclusive (ie. you can only specify one way to display or export your journal at a time).
|
||||
|
||||
Listing Journals
|
||||
----------------
|
||||
|
||||
You can list the journals accessible by jrnl::
|
||||
|
||||
jrnl -ls
|
||||
|
||||
The journals displayed correspond to those specified in the jrnl configuration file.
|
||||
|
||||
Composing Entries
|
||||
-----------------
|
||||
|
||||
Composing mode is entered by either starting ``jrnl`` without any arguments -- which will prompt you to write an entry or launch your editor -- or by just writing an entry on the prompt, such as::
|
||||
|
||||
jrnl today at 3am: I just met Steve Buscemi in a bar! He looked funny.
|
||||
|
||||
|
||||
.. note::
|
||||
|
||||
Most shell contains a certain number of reserved characters, such as ``#`` and ``*``. Unbalanced quotes, parenthesis, and so on will also get into the way of your editing. For writing longer entries, just enter ``jrnl`` and hit ``return``. Only then enter the text of your journal entry. Alternatively, :doc:`use an external editor <advanced>`).
|
||||
|
||||
You can also import an entry directly from a file::
|
||||
|
||||
jrnl < my_entry.txt
|
||||
|
||||
Smart timestamps
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
Timestamps that work:
|
||||
|
||||
* at 6am
|
||||
* yesterday
|
||||
* last monday
|
||||
* sunday at noon
|
||||
* 2 march 2012
|
||||
* 7 apr
|
||||
* 5/20/1998 at 23:42
|
||||
|
||||
Starring entries
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
To mark an entry as a favourite, simply "star" it::
|
||||
|
||||
jrnl last sunday *: Best day of my life.
|
||||
|
||||
If you don't want to add a date (ie. your entry will be dated as now), The following options are equivalent:
|
||||
|
||||
* ``jrnl *: Best day of my life.``
|
||||
* ``jrnl *Best day of my life.``
|
||||
* ``jrnl Best day of my life.*``
|
||||
|
||||
.. note::
|
||||
|
||||
Just make sure that the asterisk sign is **not** surrounded by whitespaces, e.g. ``jrnl Best day of my life! *`` will **not** work (the reason being that the ``*`` sign has a special meaning on most shells).
|
||||
|
||||
Viewing
|
||||
-------
|
||||
|
||||
::
|
||||
|
||||
jrnl -n 10
|
||||
|
||||
will list you the ten latest entries (if you're lazy, ``jrnl -10`` will do the same), ::
|
||||
|
||||
jrnl -from "last year" -until march
|
||||
|
||||
everything that happened from the start of last year to the start of last march. To only see your favourite entries, use ::
|
||||
|
||||
jrnl -starred
|
||||
|
||||
Using Tags
|
||||
----------
|
||||
|
||||
Keep track of people, projects or locations, by tagging them with an ``@`` in your entries ::
|
||||
|
||||
jrnl Had a wonderful day on the @beach with @Tom and @Anna.
|
||||
|
||||
You can filter your journal entries just like this: ::
|
||||
|
||||
jrnl @pinkie @WorldDomination
|
||||
|
||||
Will print all entries in which either ``@pinkie`` or ``@WorldDomination`` occurred. ::
|
||||
|
||||
jrnl -n 5 -and @pineapple @lubricant
|
||||
|
||||
the last five entries containing both ``@pineapple`` **and** ``@lubricant``. You can change which symbols you'd like to use for tagging in the configuration.
|
||||
|
||||
.. note::
|
||||
|
||||
``jrnl @pinkie @WorldDomination`` will switch to viewing mode because although **no** command line arguments are given, all the input strings look like tags - *jrnl* will assume you want to filter by tag.
|
||||
|
||||
Editing older entries
|
||||
---------------------
|
||||
|
||||
You can edit selected entries after you wrote them. This is particularly useful when your journal file is encrypted or if you're using a DayOne journal. To use this feature, you need to have an editor configured in your journal configuration file (see :doc:`advanced usage <advanced>`)::
|
||||
|
||||
jrnl -until 1950 @texas -and @history --edit
|
||||
|
||||
Will open your editor with all entries tagged with ``@texas`` and ``@history`` before 1950. You can make any changes to them you want; after you save the file and close the editor, your journal will be updated.
|
||||
|
||||
Of course, if you are using multiple journals, you can also edit e.g. the latest entry of your work journal with ``jrnl work -n 1 --edit``. In any case, this will bring up your editor and save (and, if applicable, encrypt) your edited journal after you save and exit the editor.
|
||||
|
||||
You can also use this feature for deleting entries from your journal::
|
||||
|
||||
jrnl @girlfriend -until 'june 2012' --edit
|
||||
|
||||
Just select all text, press delete, and everything is gone...
|
||||
|
||||
Editing DayOne Journals
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
DayOne journals can be edited exactly the same way, however the output looks a little bit different because of the way DayOne stores its entries:
|
||||
|
||||
.. code-block:: output
|
||||
|
||||
# af8dbd0d43fb55458f11aad586ea2abf
|
||||
2013-05-02 15:30 I told everyone I built my @robot wife for sex.
|
||||
But late at night when we're alone we mostly play Battleship.
|
||||
|
||||
# 2391048fe24111e1983ed49a20be6f9e
|
||||
2013-08-10 03:22 I had all kinds of plans in case of a @zombie attack.
|
||||
I just figured I'd be on the other side.
|
||||
|
||||
The long strings starting with hash symbol are the so-called UUIDs, unique identifiers for each entry. Don't touch them. If you do, then the old entry would get deleted and a new one written, which means that you could lose DayOne data that jrnl can't handle (such as as the entry's geolocation).
|
||||
|
||||
11
mkdocs.yml
Normal file
11
mkdocs.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
site_name: jrnl
|
||||
theme: readthedocs
|
||||
extra_css:
|
||||
- https://fonts.googleapis.com/css?family=Merriweather|Open+Sans
|
||||
- assets/theme.css
|
||||
- assets/highlight.css
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
repo_url: https://github.com/jrnl-org/jrnl/
|
||||
site_author: Manuel Ebert
|
||||
site_description: Never Worry about Money Again.
|
||||
Loading…
Add table
Reference in a new issue