fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-07-11 17:46:12 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs from master

Browse source
This commit is contained in:
Jon Johnson 2014-06-24 13:41:12 -04:00
parent f4344c8793
commit 73f50a40cd
59 changed files with 720 additions and 840 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/_build/html/installation.html vendored
View file

@ -1,4 +1,3 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@ -14,7 +13,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
URL_ROOT: './',
VERSION: '1.8.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
@ -45,10 +44,12 @@
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<p>Install <em>jrnl</em> using pip</p>
<div class="highlight-python"><pre>pip install jrnl</pre>
<div class="highlight-python"><div class="highlight"><pre>pip install jrnl
</pre></div>
</div>
<p>Or, if you want the option to encrypt your journal,</p>
<div class="highlight-python"><pre>pip install jrnl[encrypted]</pre>
<div class="highlight-python"><div class="highlight"><pre>pip install jrnl[encrypted]
</pre></div>
</div>
<p>to install the dependencies for encrypting journals as well.</p>
<div class="admonition note">
@ -60,11 +61,13 @@
<div class="section" id="quickstart">
<h2>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline"></a></h2>
<p>to make a new entry, just type:</p>
<div class="highlight-python"><pre>jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book.</pre>
<div class="highlight-python"><div class="highlight"><pre>jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book.
</pre></div>
</div>
<p>and hit return. <tt class="docutils literal"><span class="pre">yesterday:</span></tt> will be interpreted as a time stamp. Everything until the first sentence mark (<tt class="docutils literal"><span class="pre">.?!:</span></tt>) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this:</p>
<div class="highlight-output"><pre>2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book.</pre>
<div class="highlight-output"><div class="highlight"><pre>2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book.
</pre></div>
</div>
<p>If you just call <tt class="docutils literal"><span class="pre">jrnl</span></tt>, you will be prompted to compose your entry - but you can also configure <em>jrnl</em> to use your external editor.</p>
</div>