1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-11-27 08:21:03 +02:00

Updated website

This commit is contained in:
Laurent Cozic 2018-04-04 21:48:42 +02:00
parent 003e2afff7
commit 67145d9104
3 changed files with 315 additions and 8 deletions

View File

@ -385,6 +385,7 @@ async function main() {
// renderFileToHtml(rootDir + '/README.md', rootDir + '/docs/index.html', {});
renderFileToHtml(rootDir + '/readme/terminal.md', rootDir + '/docs/terminal/index.html', {});
renderFileToHtml(rootDir + '/readme/debugging.md', rootDir + '/docs/debugging/index.html', {});
renderFileToHtml(rootDir + '/readme/desktop.md', rootDir + '/docs/desktop/index.html', {});
renderFileToHtml(rootDir + '/readme/mobile.md', rootDir + '/docs/mobile/index.html', {});
renderFileToHtml(rootDir + '/readme/e2ee.md', rootDir + '/docs/e2ee/index.html', {});

306
docs/debugging/index.html Normal file
View File

@ -0,0 +1,306 @@
<!doctype html>
<html>
<head>
<title>Joplin - an open source note taking and to-do application with synchronisation capabilities</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="https://joplin.cozic.net/css/bootstrap.min.css">
<link rel="shortcut icon" type="image/x-icon" href="favicon.ico">
<link rel="stylesheet" href="https://joplin.cozic.net/css/fontawesome-all.min.css">
<script src="https://joplin.cozic.net/js/jquery-3.2.1.slim.min.js"></script>
<style>
body {
background-color: #F1F1F1;
color: #333333;
}
table {
margin-bottom: 1em;
}
td, th {
padding: .8em;
border: 1px solid #ccc;
}
h1, h2 {
border-bottom: 1px solid #eaecef;
padding-bottom: 0.3em;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-weight: 600;
font-size: 2em;
margin-bottom: 16px;
}
h2 {
font-size: 1.6em;
}
h3 {
font-size: 1.3em;
}
code {
color: black;
background-color: #eee;
border: 1px solid #ccc;
font-size: .85em;
}
pre code {
border: none;
}
pre {
font-size: .85em;
}
#toc ul {
margin-bottom: 10px;
}
#toc {
padding-bottom: 1em;
}
.title-icon {
height: 2em;
}
.sub-title {
font-weight: bold;
font-size: 1.5em;
}
.container {
background-color: white;
padding: 0;
box-shadow: 0 10px 20px #888888;
}
table.screenshots {
margin-top: 2em;
margin-bottom: 2em;
}
table.screenshots th {
height: 3em;
text-align: center;
}
table.screenshots th,
table.screenshots td {
border: 1px solid #C2C2C2;
}
img[align="left"] {
margin-right: 10px;
margin-bottom: 10px;
}
.mobile-screenshot {
height: 40em;
padding: 1em;
}
.cli-screenshot-wrapper {
background-color: black;
vertical-align: top;
padding: 1em 2em 1em 1em;
}
.cli-screenshot {
font-family: "Monaco", "Inconsolata", "CONSOLAS", "Deja Vu Sans Mono", "Droid Sans Mono", "Andale Mono", monospace;
background-color: black;
color: white;
border: none;
}
.cli-screenshot .prompt {
color: #48C2F0;
}
.top-screenshot {
margin-top: 2em;
text-align: center;
}
.header {
position: relative;
padding-left: 2em;
padding-right: 2em;
padding-top: 1em;
padding-bottom: 1em;
color: white;
background-color: #2B2B3D;
}
.header a h1 {
color: white;
}
.content {
padding-left: 2em;
padding-right: 2em;
padding-bottom: 2em;
padding-top: 2em;
}
.forkme {
position: absolute;
right: 0;
top:0;
}
.nav-wrapper {
position: relative;
width: inherit;
}
.nav {
background-color: black;
display: table;
width: inherit;
}
.nav.sticky {
position:fixed;
top: 0;
width: inherit;
box-shadow: 0 0 10px #000000;
}
.nav a {
color: white;
display: inline-block;
padding: .6em .9em .6em .9em;
}
.nav ul {
padding-left: 2em;
margin-bottom: 0;
display: table-cell;
min-width: 165px;
}
.nav ul li {
display: inline-block;
padding: 0;
}
.nav li.selected {
background-color: #222;
font-weight: bold;
}
.nav-right {
display: table-cell;
width: 100%;
text-align: right;
vertical-align: middle;
line-height: 0;
}
.nav-right .share-btn {
display: none;
}
.share-btn-github {
display: inline-block;
}
.nav-right .small-share-btn {
display: none;
}
.nav-right .share-btn-github {
display: inline-block;
}
.footer {
padding-top: 1em;
border-top: 1px solid #d4d4d4;
margin-top: 2em;
color: gray;
font-size: .9em;
}
@media all and (min-width: 400px) {
.nav-right .share-btn {
display: inline-block;
}
.nav-right .small-share-btn {
display: none;
}
}
</style>
</head>
<body>
<div class="container">
<div class="header">
<a class="forkme" href="https://github.com/laurent22/joplin"><img src="https://joplin.cozic.net/images/ForkMe.png"/></a>
<a href="https://joplin.cozic.net"><h1 id="joplin"><img class="title-icon" src="https://joplin.cozic.net/images/Icon512.png">oplin</h1></a>
<p class="sub-title">An open source note taking and to-do application with synchronisation capabilities.</p>
</div>
<div class="nav-wrapper">
<div class="nav">
<ul>
<li class=""><a href="https:&#x2F;&#x2F;joplin.cozic.net/" title="Home"><i class="fa fa-home"></i></a></li>
<li><a class="help" href="#" title="Terminal">Help</a></li>
</ul>
<div class="nav-right">
<iframe class="share-btn" src="https://www.facebook.com/plugins/share_button.php?href=http%3A%2F%2Fjoplin.cozic.net&layout=button&size=small&mobile_iframe=true&width=60&height=20&appId" width="60" height="20" style="border:none;overflow:hidden" scrolling="no" frameborder="0" allowTransparency="true"></iframe>
<iframe class="share-btn" src="https://platform.twitter.com/widgets/tweet_button.html?url=http%3A%2F%2Fjoplin.cozic.net" width="62" height="20" title="Tweet" style="border: 0; overflow: hidden;"></iframe>
<iframe class="share-btn share-btn-github" src="https://ghbtns.com/github-btn.html?user=laurent22&repo=joplin&type=star&count=true" frameborder="0" scrolling="0" width="100px" height="20px"></iframe>
</div>
</div>
</div>
<div class="content">
<div id="toc"><ul>
<li>
<p>Applications</p>
<ul>
<li><a href="https://joplin.cozic.net/desktop">Desktop application</a></li>
<li><a href="https://joplin.cozic.net/mobile">Mobile applications</a></li>
<li><a href="https://joplin.cozic.net/terminal">Terminal application</a></li>
</ul>
</li>
<li>
<p>Support</p>
<ul>
<li><a href="https://joplin.cozic.net/e2ee">How to enable end-to-end encryption</a></li>
<li><a href="https://joplin.cozic.net/spec">End-to-end encryption spec</a></li>
<li><a href="https://joplin.cozic.net/debugging">How to enable debug mode</a></li>
</ul>
</li>
<li>
<p>About</p>
<ul>
<li><a href="https://joplin.cozic.net/changelog">Changelog</a></li>
<li><a href="https://joplin.cozic.net/stats">Stats</a></li>
<li><a href="https://joplin.cozic.net/donate">Donate</a></li>
</ul>
</li>
</ul>
</div>
<h1 id="how-to-enable-debugging">How to enable debugging</h1>
<p>It is possible to get the apps to display or log more information that might help debug various issues.</p>
<h2 id="desktop-application">Desktop application</h2>
<ul>
<li>Add a file named &quot;flags.txt&quot; in the config directory (should be <code>~/.config/joplin-desktop</code> or <code>c:\Users\YOUR_NAME\.config\joplin-desktop</code>) with the following content: <code>--open-dev-tools --log-level debug</code></li>
<li>Restart the application</li>
<li>The development tools should now be opened. Click the &quot;Console&quot; tab</li>
<li>Now repeat the action that was causing problem. The console might output warnings or errors - please add them to the GitHub issue. Also open log.txt in the config folder and if there is any error or warning, please also add them to the issue.</li>
</ul>
<h2 id="cli-application">CLI application</h2>
<ul>
<li>Start the app with <code>joplin --log-level debug</code></li>
<li>Check the log.txt as specified above for the desktop application and attach the log to the GitHub issue (or just the warnings/errors if any)</li>
</ul>
<h2 id="mobile-application">Mobile application</h2>
<ul>
<li>In the options, enable Advanced Option</li>
<li>Open the log in the top right hand corner menu and post a screenshot of any error/warning.</li>
</ul>
<script>
function stickyHeader() {
return; // Disabled
if ($(window).scrollTop() > 179) {
$('.nav').addClass('sticky');
} else {
$('.nav').removeClass('sticky');
}
}
$('#toc').hide();
$('.help').click(function(event) {
event.preventDefault();
$('#toc').show();
});
$(window).scroll(function() {
stickyHeader();
});
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-103586105-1', 'auto');
ga('send', 'pageview');
</script>
<div class="footer">
Copyright (c) 2016-2018 Laurent Cozic
</div>
</body>
</html>

View File

@ -463,14 +463,14 @@ $$
<td><img src="https://joplin.cozic.net/images/flags/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="&#109;&#97;&#x69;&#x6c;&#x74;&#x6f;&#x3a;&#x74;&#x72;&#98;&#x75;&#104;&#111;&#109;&#x40;&#x6e;&#x65;&#116;&#46;&#x68;&#x72;">&#x74;&#x72;&#98;&#x75;&#104;&#111;&#109;&#x40;&#x6e;&#x65;&#116;&#46;&#x68;&#x72;</a></td>
<td>Hrvoje Mandić <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#x74;&#114;&#x62;&#x75;&#x68;&#111;&#109;&#64;&#110;&#x65;&#116;&#x2e;&#104;&#114;">&#x74;&#114;&#x62;&#x75;&#x68;&#111;&#109;&#64;&#110;&#x65;&#116;&#x2e;&#104;&#114;</a></td>
<td>62%</td>
</tr>
<tr>
<td><img src="https://joplin.cozic.net/images/flags/country-4x3/cz.png" alt=""></td>
<td>Czech</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/cs_CZ.po">cs_CZ</a></td>
<td>Lukas Helebrandt <a href="&#109;&#97;&#105;&#x6c;&#116;&#111;&#58;&#x6c;&#117;&#107;&#x61;&#115;&#x40;&#97;&#105;&#121;&#97;&#46;&#x63;&#x7a;">&#x6c;&#117;&#107;&#x61;&#115;&#x40;&#97;&#105;&#121;&#97;&#46;&#x63;&#x7a;</a></td>
<td>Lukas Helebrandt <a href="&#x6d;&#97;&#x69;&#108;&#116;&#111;&#x3a;&#108;&#x75;&#x6b;&#97;&#115;&#x40;&#97;&#105;&#x79;&#97;&#46;&#99;&#122;">&#108;&#x75;&#x6b;&#97;&#115;&#x40;&#97;&#105;&#x79;&#97;&#46;&#99;&#122;</a></td>
<td>97%</td>
</tr>
<tr>
@ -484,7 +484,7 @@ $$
<td><img src="https://joplin.cozic.net/images/flags/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 Grasse <a href="&#x6d;&#x61;&#105;&#108;&#116;&#x6f;&#x3a;&#x6d;&#97;&#x69;&#x6c;&#x40;&#x74;&#x6f;&#98;&#105;&#x61;&#x73;&#x2d;&#103;&#x72;&#97;&#x73;&#115;&#101;&#46;&#x6e;&#101;&#x74;">&#x6d;&#97;&#x69;&#x6c;&#x40;&#x74;&#x6f;&#98;&#105;&#x61;&#x73;&#x2d;&#103;&#x72;&#97;&#x73;&#115;&#101;&#46;&#x6e;&#101;&#x74;</a></td>
<td>Tobias Grasse <a href="&#109;&#97;&#105;&#108;&#x74;&#x6f;&#x3a;&#109;&#97;&#x69;&#108;&#64;&#x74;&#111;&#98;&#x69;&#x61;&#x73;&#45;&#103;&#x72;&#97;&#x73;&#x73;&#x65;&#46;&#110;&#101;&#116;">&#109;&#97;&#x69;&#108;&#64;&#x74;&#111;&#98;&#x69;&#x61;&#x73;&#45;&#103;&#x72;&#97;&#x73;&#x73;&#x65;&#46;&#110;&#101;&#116;</a></td>
<td>96%</td>
</tr>
<tr>
@ -498,7 +498,7 @@ $$
<td><img src="https://joplin.cozic.net/images/flags/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="&#x6d;&#97;&#105;&#108;&#116;&#x6f;&#x3a;&#x66;&#64;&#109;&#x72;&#x74;&#x6e;&#46;&#101;&#115;">&#x66;&#64;&#109;&#x72;&#x74;&#x6e;&#46;&#101;&#115;</a></td>
<td>Fernando Martín <a href="&#x6d;&#97;&#x69;&#x6c;&#x74;&#x6f;&#x3a;&#102;&#64;&#109;&#x72;&#x74;&#110;&#46;&#x65;&#115;">&#102;&#64;&#109;&#x72;&#x74;&#110;&#46;&#x65;&#115;</a></td>
<td>96%</td>
</tr>
<tr>
@ -512,7 +512,7 @@ $$
<td><img src="https://joplin.cozic.net/images/flags/country-4x3/es.png" alt=""></td>
<td>Galician</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/gl_ES.po">gl_ES</a></td>
<td>José Antonio Martínez <a href="&#109;&#97;&#105;&#x6c;&#x74;&#x6f;&#58;&#x66;&#97;&#x63;&#x65;&#x6d;&#x6f;&#x73;&#x68;&#x69;&#115;&#116;&#111;&#x72;&#x69;&#97;&#x40;&#103;&#x6d;&#97;&#105;&#108;&#46;&#99;&#111;&#x6d;">&#x66;&#97;&#x63;&#x65;&#x6d;&#x6f;&#x73;&#x68;&#x69;&#115;&#116;&#111;&#x72;&#x69;&#97;&#x40;&#103;&#x6d;&#97;&#105;&#108;&#46;&#99;&#111;&#x6d;</a></td>
<td>José Antonio Martínez <a href="&#109;&#x61;&#105;&#108;&#x74;&#x6f;&#x3a;&#102;&#97;&#99;&#x65;&#x6d;&#x6f;&#115;&#x68;&#105;&#115;&#116;&#111;&#x72;&#x69;&#97;&#x40;&#x67;&#x6d;&#97;&#x69;&#x6c;&#x2e;&#x63;&#111;&#109;">&#102;&#97;&#99;&#x65;&#x6d;&#x6f;&#115;&#x68;&#105;&#115;&#116;&#111;&#x72;&#x69;&#97;&#x40;&#x67;&#x6d;&#97;&#x69;&#x6c;&#x2e;&#x63;&#111;&#109;</a></td>
<td>100%</td>
</tr>
<tr>
@ -533,21 +533,21 @@ $$
<td><img src="https://joplin.cozic.net/images/flags/country-4x3/br.png" alt=""></td>
<td>Português (Brasil)</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/pt_BR.po">pt_BR</a></td>
<td>Renato Nunes Bastos <a href="&#109;&#x61;&#x69;&#108;&#x74;&#x6f;&#x3a;&#114;&#x6e;&#x62;&#97;&#x73;&#116;&#111;&#x73;&#x40;&#103;&#x6d;&#x61;&#105;&#108;&#x2e;&#99;&#111;&#109;">&#114;&#x6e;&#x62;&#97;&#x73;&#116;&#111;&#x73;&#x40;&#103;&#x6d;&#x61;&#105;&#108;&#x2e;&#99;&#111;&#109;</a></td>
<td>Renato Nunes Bastos <a href="&#109;&#97;&#x69;&#x6c;&#116;&#111;&#x3a;&#114;&#x6e;&#98;&#x61;&#115;&#116;&#111;&#x73;&#x40;&#103;&#x6d;&#97;&#105;&#108;&#46;&#99;&#x6f;&#x6d;">&#114;&#x6e;&#98;&#x61;&#115;&#116;&#111;&#x73;&#x40;&#103;&#x6d;&#97;&#105;&#108;&#46;&#99;&#x6f;&#x6d;</a></td>
<td>95%</td>
</tr>
<tr>
<td><img src="https://joplin.cozic.net/images/flags/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="&#x6d;&#x61;&#105;&#108;&#116;&#111;&#58;&#97;&#114;&#x74;&#x79;&#111;&#x6d;&#46;&#x6b;&#97;&#x72;&#108;&#x6f;&#x76;&#64;&#x67;&#x6d;&#97;&#x69;&#108;&#x2e;&#x63;&#111;&#x6d;">&#97;&#114;&#x74;&#x79;&#111;&#x6d;&#46;&#x6b;&#97;&#x72;&#108;&#x6f;&#x76;&#64;&#x67;&#x6d;&#97;&#x69;&#108;&#x2e;&#x63;&#111;&#x6d;</a></td>
<td>Artyom Karlov <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#x61;&#114;&#116;&#121;&#111;&#x6d;&#46;&#x6b;&#x61;&#114;&#x6c;&#x6f;&#x76;&#64;&#x67;&#109;&#97;&#105;&#108;&#x2e;&#99;&#x6f;&#x6d;">&#x61;&#114;&#116;&#121;&#111;&#x6d;&#46;&#x6b;&#x61;&#114;&#x6c;&#x6f;&#x76;&#64;&#x67;&#109;&#97;&#105;&#108;&#x2e;&#99;&#x6f;&#x6d;</a></td>
<td>96%</td>
</tr>
<tr>
<td><img src="https://joplin.cozic.net/images/flags/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="&#109;&#97;&#x69;&#108;&#116;&#111;&#x3a;&#82;&#67;&#x4a;&#x61;&#x63;&#72;&#64;&#x6f;&#117;&#116;&#x6c;&#x6f;&#111;&#x6b;&#x2e;&#99;&#x6f;&#x6d;">&#82;&#67;&#x4a;&#x61;&#x63;&#72;&#64;&#x6f;&#117;&#116;&#x6c;&#x6f;&#111;&#x6b;&#x2e;&#99;&#x6f;&#x6d;</a></td>
<td>RCJacH <a href="&#x6d;&#97;&#x69;&#x6c;&#116;&#x6f;&#58;&#x52;&#67;&#x4a;&#x61;&#x63;&#72;&#64;&#111;&#x75;&#116;&#x6c;&#x6f;&#x6f;&#107;&#x2e;&#x63;&#111;&#109;">&#x52;&#67;&#x4a;&#x61;&#x63;&#72;&#64;&#111;&#x75;&#116;&#x6c;&#x6f;&#x6f;&#107;&#x2e;&#x63;&#111;&#109;</a></td>
<td>64%</td>
</tr>
<tr>