1
0
mirror of https://github.com/laurent22/joplin.git synced 2025-01-11 18:24:43 +02:00

Update readme

This commit is contained in:
Laurent Cozic 2018-02-16 23:14:26 +00:00
parent 1bc4d6b423
commit 344d0e2687
7 changed files with 33 additions and 9 deletions

View File

@ -124,7 +124,7 @@ You will need to set the `sync.target` config variable and all the `sync.5.path`
:config sync.5.username YOUR_USERNAME
:config sync.5.password YOUR_PASSWORD
If synchronisation does not work, please consult the logs in the app profile directory - it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.
If synchronisation does not work, please consult the logs in the app profile directory (`~/.config/joplin`)- it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.
## WebDAV synchronisation
@ -198,7 +198,7 @@ There are two types of shortcuts: those that manipulate the user interface direc
yn cp $n ""
dn mv $n ""
Shortcut can be configured by adding a file `keymap.json` to the profile directory. The content of this file is a JSON array with each entry defining a command and the keys associated with it.
Shortcut can be configured by adding a keymap file to the profile directory in `~/.config/joplin/keymap.json`. The content of this file is a JSON array with each entry defining a command and the keys associated with it.
As an example, this is the default keymap, but read below for a detailed explanation of each property.

View File

@ -44,10 +44,14 @@ const headerHtml = `<!doctype html>
color: black;
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
}
pre code {
border: none;
}
pre {
font-size: .85em;
}
.title-icon {
height: 2em;
}

View File

@ -39,10 +39,14 @@
color: black;
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
}
pre code {
border: none;
}
pre {
font-size: .85em;
}
.title-icon {
height: 2em;
}

View File

@ -39,10 +39,14 @@
color: black;
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
}
pre code {
border: none;
}
pre {
font-size: .85em;
}
.title-icon {
height: 2em;
}

View File

@ -39,10 +39,14 @@
color: black;
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
}
pre code {
border: none;
}
pre {
font-size: .85em;
}
.title-icon {
height: 2em;
}

View File

@ -39,10 +39,14 @@
color: black;
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
}
pre code {
border: none;
}
pre {
font-size: .85em;
}
.title-icon {
height: 2em;
}
@ -392,14 +396,14 @@ $$
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/hr.png" alt=""></td>
<td>Croatian</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/hr_HR.po">hr_HR</a></td>
<td>Hrvoje Mandić <a href="&#x6d;&#x61;&#x69;&#x6c;&#x74;&#x6f;&#58;&#116;&#114;&#98;&#x75;&#104;&#x6f;&#x6d;&#x40;&#x6e;&#101;&#x74;&#x2e;&#104;&#114;">&#116;&#114;&#98;&#x75;&#104;&#x6f;&#x6d;&#x40;&#x6e;&#101;&#x74;&#x2e;&#104;&#114;</a></td>
<td>Hrvoje Mandić <a href="&#x6d;&#97;&#105;&#x6c;&#x74;&#x6f;&#x3a;&#x74;&#114;&#98;&#117;&#104;&#111;&#109;&#x40;&#x6e;&#x65;&#x74;&#x2e;&#104;&#114;">&#x74;&#114;&#98;&#117;&#104;&#111;&#109;&#x40;&#x6e;&#x65;&#x74;&#x2e;&#104;&#114;</a></td>
<td>71%</td>
</tr>
<tr>
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/de.png" alt=""></td>
<td>Deutsch</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/de_DE.po">de_DE</a></td>
<td>Tobias Strobel <a href="&#x6d;&#97;&#105;&#108;&#116;&#111;&#58;&#103;&#x69;&#116;&#x40;&#x73;&#116;&#114;&#111;&#x62;&#x65;&#108;&#x74;&#111;&#x62;&#x69;&#97;&#x73;&#46;&#100;&#x65;">&#103;&#x69;&#116;&#x40;&#x73;&#116;&#114;&#111;&#x62;&#x65;&#108;&#x74;&#111;&#x62;&#x69;&#97;&#x73;&#46;&#100;&#x65;</a></td>
<td>Tobias Strobel <a href="&#x6d;&#x61;&#105;&#108;&#x74;&#111;&#58;&#x67;&#x69;&#x74;&#64;&#115;&#116;&#x72;&#111;&#98;&#101;&#x6c;&#x74;&#111;&#98;&#x69;&#x61;&#115;&#46;&#x64;&#101;">&#x67;&#x69;&#x74;&#64;&#115;&#116;&#x72;&#111;&#98;&#101;&#x6c;&#x74;&#111;&#98;&#x69;&#x61;&#115;&#46;&#x64;&#101;</a></td>
<td>90%</td>
</tr>
<tr>
@ -413,7 +417,7 @@ $$
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/es.png" alt=""></td>
<td>Español</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/es_ES.po">es_ES</a></td>
<td>Fernando Martín <a href="&#109;&#97;&#x69;&#108;&#x74;&#x6f;&#x3a;&#x66;&#x40;&#109;&#x72;&#x74;&#110;&#46;&#x65;&#115;">&#x66;&#x40;&#109;&#x72;&#x74;&#110;&#46;&#x65;&#115;</a></td>
<td>Fernando Martín <a href="&#x6d;&#x61;&#x69;&#x6c;&#x74;&#x6f;&#x3a;&#x66;&#64;&#x6d;&#114;&#x74;&#110;&#46;&#x65;&#115;">&#x66;&#64;&#x6d;&#114;&#x74;&#110;&#46;&#x65;&#115;</a></td>
<td>98%</td>
</tr>
<tr>
@ -455,14 +459,14 @@ $$
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/ru.png" alt=""></td>
<td>Русский</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/ru_RU.po">ru_RU</a></td>
<td>Artyom Karlov <a href="&#109;&#x61;&#x69;&#108;&#x74;&#111;&#x3a;&#97;&#114;&#116;&#x79;&#111;&#x6d;&#46;&#x6b;&#x61;&#114;&#x6c;&#111;&#118;&#x40;&#103;&#109;&#x61;&#105;&#x6c;&#46;&#99;&#x6f;&#109;">&#97;&#114;&#116;&#x79;&#111;&#x6d;&#46;&#x6b;&#x61;&#114;&#x6c;&#111;&#118;&#x40;&#103;&#109;&#x61;&#105;&#x6c;&#46;&#99;&#x6f;&#109;</a></td>
<td>Artyom Karlov <a href="&#x6d;&#x61;&#105;&#108;&#116;&#111;&#x3a;&#x61;&#x72;&#x74;&#x79;&#x6f;&#109;&#46;&#x6b;&#97;&#114;&#108;&#111;&#118;&#64;&#x67;&#x6d;&#x61;&#x69;&#108;&#x2e;&#99;&#111;&#109;">&#x61;&#x72;&#x74;&#x79;&#x6f;&#109;&#46;&#x6b;&#97;&#114;&#108;&#111;&#118;&#64;&#x67;&#x6d;&#x61;&#x69;&#108;&#x2e;&#99;&#111;&#109;</a></td>
<td>92%</td>
</tr>
<tr>
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/cn.png" alt=""></td>
<td>中文 (简体)</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/zh_CN.po">zh_CN</a></td>
<td>RCJacH <a href="&#x6d;&#97;&#105;&#x6c;&#x74;&#x6f;&#58;&#x52;&#x43;&#x4a;&#x61;&#x63;&#72;&#x40;&#111;&#x75;&#x74;&#x6c;&#111;&#x6f;&#107;&#x2e;&#x63;&#111;&#109;">&#x52;&#x43;&#x4a;&#x61;&#x63;&#72;&#x40;&#111;&#x75;&#x74;&#x6c;&#111;&#x6f;&#107;&#x2e;&#x63;&#111;&#109;</a></td>
<td>RCJacH <a href="&#x6d;&#x61;&#105;&#x6c;&#116;&#x6f;&#58;&#82;&#x43;&#74;&#97;&#x63;&#72;&#64;&#x6f;&#117;&#116;&#x6c;&#111;&#x6f;&#x6b;&#46;&#99;&#x6f;&#x6d;">&#82;&#x43;&#74;&#97;&#x63;&#72;&#64;&#x6f;&#117;&#116;&#x6c;&#111;&#x6f;&#x6b;&#46;&#99;&#x6f;&#x6d;</a></td>
<td>75%</td>
</tr>
<tr>

View File

@ -39,10 +39,14 @@
color: black;
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
}
pre code {
border: none;
}
pre {
font-size: .85em;
}
.title-icon {
height: 2em;
}
@ -304,7 +308,7 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin
:config sync.5.path https://example.com/nextcloud/remote.php/dav/files/USERNAME/
:config sync.5.username YOUR_USERNAME
:config sync.5.password YOUR_PASSWORD
</code></pre><p>If synchronisation does not work, please consult the logs in the app profile directory - it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.</p>
</code></pre><p>If synchronisation does not work, please consult the logs in the app profile directory (<code>~/.config/joplin</code>)- it is often due to a misconfigured URL or password. The log should indicate what the exact issue is.</p>
<h2 id="webdav-synchronisation">WebDAV synchronisation</h2>
<p>Select the &quot;WebDAV&quot; synchronisation target and follow the same instructions as for Nextcloud above.</p>
<h2 id="onedrive-synchronisation">OneDrive synchronisation</h2>
@ -351,7 +355,7 @@ mt mktodo &quot;&quot;
mb mkbook &quot;&quot;
yn cp $n &quot;&quot;
dn mv $n &quot;&quot;
</code></pre><p>Shortcut can be configured by adding a file <code>keymap.json</code> to the profile directory. The content of this file is a JSON array with each entry defining a command and the keys associated with it.</p>
</code></pre><p>Shortcut can be configured by adding a keymap file to the profile directory in <code>~/.config/joplin/keymap.json</code>. The content of this file is a JSON array with each entry defining a command and the keys associated with it.</p>
<p>As an example, this is the default keymap, but read below for a detailed explanation of each property.</p>
<pre><code class="lang-json">[
{ &quot;keys&quot;: [&quot;:&quot;], &quot;type&quot;: &quot;function&quot;, &quot;command&quot;: &quot;enter_command_line_mode&quot; },