Updated docs from master

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

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',
@ -60,36 +59,42 @@
<div class="section" id="json-export">
<h2>JSON export<a class="headerlink" href="#json-export" title="Permalink to this headline"></a></h2>
<p>Can do:</p>
<div class="highlight-python"><pre>jrnl --export json</pre>
<div class="highlight-python"><div class="highlight"><pre>jrnl --export json
</pre></div>
</div>
<p>Why not create a <a class="reference external" href="http://timeline.verite.co/">beautiful timeline</a> of your journal?</p>
</div>
<div class="section" id="markdown-export">
<h2>Markdown export<a class="headerlink" href="#markdown-export" title="Permalink to this headline"></a></h2>
<p>Use:</p>
<div class="highlight-python"><pre>jrnl --export markdown</pre>
<div class="highlight-python"><div class="highlight"><pre>jrnl --export markdown
</pre></div>
</div>
<p>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.</p>
</div>
<div class="section" id="text-export">
<h2>Text export<a class="headerlink" href="#text-export" title="Permalink to this headline"></a></h2>
<div class="highlight-python"><pre>jrnl --export text</pre>
<div class="highlight-python"><div class="highlight"><pre>jrnl --export text
</pre></div>
</div>
<p>Pretty-prints your entire journal.</p>
</div>
<div class="section" id="export-to-files">
<h2>Export to files<a class="headerlink" href="#export-to-files" title="Permalink to this headline"></a></h2>
<p>You can specify the output file of your exported journal using the <cite>-o</cite> argument:</p>
<div class="highlight-python"><pre>jrnl --export md -o journal.md</pre>
<div class="highlight-python"><div class="highlight"><pre>jrnl --export md -o journal.md
</pre></div>
</div>
<p>The above command will generate a file named <cite>journal.md</cite>. If the <cite>-o</cite> argument is a directory, jrnl will export each entry into an individual file:</p>
<div class="highlight-python"><pre>jrnl --export json -o my_entries/</pre>
<div class="highlight-python"><div class="highlight"><pre>jrnl --export json -o my_entries/
</pre></div>
</div>
<p>The contents of <cite>my_entries/</cite> will then look like this:</p>
<div class="highlight-output"><pre>my_entries/
<div class="highlight-output"><div class="highlight"><pre>my_entries/
|- 2013_06_03_a-beautiful-day.json
|- 2013_06_07_dinner-with-gabriel.json
|- ...</pre>
|- ...
</pre></div>
</div>
</div>
</div>