diff --git a/README.md b/README.md index be17a3b792..1e16e488b1 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Joplin -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=E8JMYD2LQ8MMA&lc=GB&item_name=Joplin+Development¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted) [![Donate with Bitcoin](https://en.cryptobadges.io/badge/micro/1AnbeRd5NZT1ssG93jXzaDoHwzgjQAHX3R)](https://en.cryptobadges.io/donate/1AnbeRd5NZT1ssG93jXzaDoHwzgjQAHX3R) [![Travis Build Status](https://travis-ci.org/laurent22/joplin.svg?branch=master)](https://travis-ci.org/laurent22/joplin) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/laurent22/joplin?branch=master&passingText=master%20-%20OK&svg=true)](https://ci.appveyor.com/project/laurent22/joplin) +[![Donate](https://raw.githubusercontent.com/laurent22/joplin/master/docs/images/badges/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=E8JMYD2LQ8MMA&lc=GB&item_name=Joplin+Development¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted) [![Donate with Bitcoin](https://raw.githubusercontent.com/laurent22/joplin/master/docs/images/badges/Donate-Bitcoin.svg)](https://joplin.cozic.net/donate/#bitcoin) [![Travis Build Status](https://travis-ci.org/laurent22/joplin.svg?branch=master)](https://travis-ci.org/laurent22/joplin) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/github/laurent22/joplin?branch=master&passingText=master%20-%20OK&svg=true)](https://ci.appveyor.com/project/laurent22/joplin) Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in [Markdown format](#markdown). Notes exported from Evernote via .enex files [can be imported](#importing) into Joplin, including the formatted content (which is converted to Markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.). Plain Markdown files can also be imported. -The notes can be [synchronised](#synchronisation) with various cloud services including [Nextcloud](https://nextcloud.com/), the file system (for example with a network directory) or with Microsoft OneDrive. When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around. +The notes can be [synchronised](#synchronisation) with various cloud services including [Nextcloud](https://nextcloud.com/), Dropbox, OneDrive or the file system (for example with a network directory). When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around. The UI of the terminal client is built on top of the great [terminal-kit](https://github.com/cronvel/terminal-kit) library, the desktop client using [Electron](https://electronjs.org/), and the Android client front end is done using [React Native](https://facebook.github.io/react-native/). @@ -50,11 +50,33 @@ To start it, type `joplin`. For usage information, please refer to the full [Joplin Terminal Application Documentation](https://joplin.cozic.net/terminal). + +# Table of contents + +- Applications + + - [Desktop application](https://github.com/laurent22/joplin/blob/master/readme/desktop.md) + - [Mobile applications](https://github.com/laurent22/joplin/blob/master/readme/mobile.md) + - [Terminal application](https://github.com/laurent22/joplin/blob/master/readme/terminal.md) + +- Support + + - [How to enable end-to-end encryption](https://github.com/laurent22/joplin/blob/master/readme/e2ee.md) + - [End-to-end encryption spec](https://github.com/laurent22/joplin/blob/master/readme/spec.md) + - [How to enable debug mode](https://github.com/laurent22/joplin/blob/master/readme/debugging.md) + +- About + + - [Changelog](https://github.com/laurent22/joplin/blob/master/readme/changelog.md) + - [Stats](https://github.com/laurent22/joplin/blob/master/readme/stats.md) + - [Donate](https://github.com/laurent22/joplin/blob/master/readme/donate.md) + + # Features - Desktop, mobile and terminal applications. - End To End Encryption (E2EE) -- Synchronisation with various services, including NextCloud, WebDAV and OneDrive. Dropbox is planned. +- Synchronisation with various services, including NextCloud, Dropbox, WebDAV and OneDrive. - Import Enex files (Evernote export format) and Markdown files. - Export JEX files (Joplin Export format) and raw files. - Support notes, to-dos, tags and notebooks. @@ -105,9 +127,9 @@ Joplin can export to the JEX format (Joplin Export file), which is a tar file th # Synchronisation -One of the goals of Joplin was to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or OneDrive, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another or to even sync to multiple services at once. Each note, notebook, tags, as well as the relation between items is transmitted as plain text files during synchronisation, which means the data can also be moved to a different application, can be easily backed up, inspected, etc. +One of the goals of Joplin was to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or Dropbox, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another or to even sync to multiple services at once. Each note, notebook, tags, as well as the relation between items is transmitted as plain text files during synchronisation, which means the data can also be moved to a different application, can be easily backed up, inspected, etc. -Currently, synchronisation is possible with Nextcloud and OneDrive (by default) or the local filesystem. A Dropbox one will also be available once [this React Native bug](https://github.com/facebook/react-native/issues/14445) is fixed. To setup synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on "Synchronise" to start a synchronisation manually. +Currently, synchronisation is possible with Nextcloud, Dropbox (by default) or the local filesystem. To setup synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on "Synchronise" to start a synchronisation manually. ## Nextcloud synchronisation @@ -117,13 +139,23 @@ On the **desktop application** or **mobile application**, go to the config scree On the **terminal application**, you will need to set the `sync.target` config variable and all the `sync.5.path`, `sync.5.username` and `sync.5.password` config variables to, respectively the Nextcloud WebDAV URL, your username and your password. This can be done from the command line mode using: - :config sync.5.path https://example.com/nextcloud/remote.php/dav/files/USERNAME/Joplin - :config sync.5.username YOUR_USERNAME - :config sync.5.password YOUR_PASSWORD + :config sync.5.path https://example.com/nextcloud/remote.php/dav/files/USERNAME/Joplin + :config sync.5.username YOUR_USERNAME + :config sync.5.password YOUR_PASSWORD :config sync.target 5 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. +## Dropbox synchronisation + +When syncing with Dropbox, Joplin creates a sub-directory in Dropbox, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory. + +On the **desktop application** or **mobile application**, select "Dropbox" as the synchronisation target in the config screen (it is selected by default). Then, to initiate the synchronisation process, click on the "Synchronise" button in the sidebar and follow the instructions. + +On the **terminal application**, to initiate the synchronisation process, type `:sync`. You will be asked to follow a link to authorise the application. It is possible to also synchronise outside of the user interface by typing `joplin sync` from the terminal. This can be used to setup a cron script to synchronise at regular interval. For example, this would do it every 30 minutes: + + */30 * * * * /path/to/joplin sync + ## WebDAV synchronisation Select the "WebDAV" synchronisation target and follow the same instructions as for Nextcloud above. @@ -142,11 +174,9 @@ WebDAV-compatible services that are known to work with Joplin. When syncing with OneDrive, Joplin creates a sub-directory in OneDrive, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory. -On the **desktop application** or **mobile application**, select "OneDrive" as the synchronisation target in the config screen (it is selected by default). Then, to initiate the synchronisation process, click on the "Synchronise" button in the sidebar. You will be asked to login to OneDrive to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive). +On the **desktop application** or **mobile application**, select "OneDrive" as the synchronisation target in the config screen. Then, to initiate the synchronisation process, click on the "Synchronise" button in the sidebar and follow the instructions. -On the **terminal application**, to initiate the synchronisation process, type `:sync`. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive). It is possible to also synchronise outside of the user interface by typing `joplin sync` from the terminal. This can be used to setup a cron script to synchronise at regular interval. For example, this would do it every 30 minutes: - - */30 * * * * /path/to/joplin sync +On the **terminal application**, to initiate the synchronisation process, type `:sync`. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive). # Encryption @@ -180,17 +210,17 @@ Joplin uses and renders [Github-flavoured Markdown](https://github.com/adam-p/ma Math expressions can be added using the [Katex notation](https://khan.github.io/KaTeX/). To add an inline equation, wrap the expression in `$EXPRESSION$`, eg. `$\sqrt{3x-1}+(1+x)^2$`. To create an expression block, wrap it as follow: - $$ - EXPRESSION - $$ + $$ + EXPRESSION + $$ For example: - $$ - f(x) = \int_{-\infty}^\infty - \hat f(\xi)\,e^{2 \pi i \xi x} - \,d\xi - $$ + $$ + f(x) = \int_{-\infty}^\infty + \hat f(\xi)\,e^{2 \pi i \xi x} + \,d\xi + $$ Here is an example with the Markdown and rendered result side by side: @@ -200,9 +230,9 @@ Here is an example with the Markdown and rendered result side by side: Checkboxes can be added like so: - - [ ] Milk - - [ ] Rice - - [ ] Eggs + - [ ] Milk + - [ ] Rice + - [ ] Eggs The checkboxes can then be ticked in the mobile and desktop applications. diff --git a/Tools/build-website.js b/Tools/build-website.js index b1070b30ad..799642189e 100644 --- a/Tools/build-website.js +++ b/Tools/build-website.js @@ -52,6 +52,12 @@ const headerHtml = ` pre { font-size: .85em; } + #toc ul { + margin-bottom: 10px; + } + #toc { + padding-bottom: 1em; + } .title-icon { height: 2em; } @@ -175,6 +181,13 @@ const headerHtml = ` .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; @@ -200,8 +213,7 @@ const headerHtml = `
@@ -212,9 +224,13 @@ const headerHtml = `
+ {{{tocHtml}}} `; const footerHtml = ` +
+Copyright (c) 2016-2018 Laurent Cozic +
`; @@ -257,6 +273,8 @@ const footerHtml = ` const scriptHtml = ` +
+Copyright (c) 2016-2018 Laurent Cozic +
diff --git a/docs/desktop/index.html b/docs/desktop/index.html index 2127f6bbd6..22dc49bc1a 100644 --- a/docs/desktop/index.html +++ b/docs/desktop/index.html @@ -47,6 +47,12 @@ pre { font-size: .85em; } + #toc ul { + margin-bottom: 10px; + } + #toc { + padding-bottom: 1em; + } .title-icon { height: 2em; } @@ -170,6 +176,13 @@ .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; @@ -195,8 +208,7 @@
@@ -207,10 +219,40 @@
+

+

For general information relevant to all the applications, see also Joplin home page.

+
+Copyright (c) 2016-2018 Laurent Cozic +
diff --git a/docs/donate/index.html b/docs/donate/index.html index a6393641e9..d5717ec6eb 100644 --- a/docs/donate/index.html +++ b/docs/donate/index.html @@ -47,6 +47,12 @@ pre { font-size: .85em; } + #toc ul { + margin-bottom: 10px; + } + #toc { + padding-bottom: 1em; + } .title-icon { height: 2em; } @@ -170,6 +176,13 @@ .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; @@ -195,8 +208,7 @@
@@ -207,6 +219,33 @@
+

Support Joplin development

Donations to Joplin support the development of the project. Developing quality applications mostly takes time, but there are also some expenses, such as digital certificates to sign the applications, app store fees, hosting, etc. Most of all, your donation will make it possible to keep up the current development standard.

There are various ways to send a donation:

@@ -225,6 +264,8 @@ +
+Copyright (c) 2016-2018 Laurent Cozic +
diff --git a/docs/e2ee/index.html b/docs/e2ee/index.html index 8809993987..89e5953bd0 100644 --- a/docs/e2ee/index.html +++ b/docs/e2ee/index.html @@ -47,6 +47,12 @@ pre { font-size: .85em; } + #toc ul { + margin-bottom: 10px; + } + #toc { + padding-bottom: 1em; + } .title-icon { height: 2em; } @@ -170,6 +176,13 @@ .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; @@ -195,8 +208,7 @@
@@ -207,6 +219,33 @@
+

About End-To-End Encryption (E2EE)

End-to-end encryption (E2EE) is a system where only the owner of the data (i.e. notes, notebooks, tags or resources) can read it. It prevents potential eavesdroppers - including telecom providers, internet providers, and even the developers of Joplin from being able to access the data.

The system is designed to defeat any attempts at surveillance or tampering because no third party can decipher the data being communicated or stored.

@@ -230,6 +269,8 @@ +
+Copyright (c) 2016-2018 Laurent Cozic +
diff --git a/docs/images/badges/Donate-Bitcoin.svg b/docs/images/badges/Donate-Bitcoin.svg new file mode 100644 index 0000000000..b203a2b151 --- /dev/null +++ b/docs/images/badges/Donate-Bitcoin.svg @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + Donate + Donate + Bitcoin + Bitcoin + + \ No newline at end of file diff --git a/docs/images/badges/Donate-PayPal-green.svg b/docs/images/badges/Donate-PayPal-green.svg new file mode 100644 index 0000000000..24acb68177 --- /dev/null +++ b/docs/images/badges/Donate-PayPal-green.svg @@ -0,0 +1 @@ +DonateDonatePayPalPayPal \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 307c00ee75..62d5ac0815 100644 --- a/docs/index.html +++ b/docs/index.html @@ -47,6 +47,12 @@ pre { font-size: .85em; } + #toc ul { + margin-bottom: 10px; + } + #toc { + padding-bottom: 1em; + } .title-icon { height: 2em; } @@ -170,6 +176,13 @@ .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; @@ -194,9 +207,8 @@
@@ -207,10 +219,37 @@
-

Donate Donate with Bitcoin Travis Build Status Appveyor Build Status

+ +

Donate Donate with Bitcoin Travis Build Status Appveyor Build Status

Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified either from the applications directly or from your own text editor. The notes are in Markdown format.

Notes exported from Evernote via .enex files can be imported into Joplin, including the formatted content (which is converted to Markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.). Plain Markdown files can also be imported.

-

The notes can be synchronised with various cloud services including Nextcloud, the file system (for example with a network directory) or with Microsoft OneDrive. When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.

+

The notes can be synchronised with various cloud services including Nextcloud, Dropbox, OneDrive or the file system (for example with a network directory). When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.

The UI of the terminal client is built on top of the great terminal-kit library, the desktop client using Electron, and the Android client front end is done using React Native.

@@ -275,7 +314,7 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin
  • Desktop, mobile and terminal applications.
  • End To End Encryption (E2EE)
    • -
  • Synchronisation with various services, including NextCloud, WebDAV and OneDrive. Dropbox is planned.
    • +
  • Synchronisation with various services, including NextCloud, Dropbox, WebDAV and OneDrive.
  • Import Enex files (Evernote export format) and Markdown files.
  • Export JEX files (Joplin Export format) and raw files.
  • Support notes, to-dos, tags and notebooks.
    • @@ -314,8 +353,8 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin

    Exporting

    Joplin can export to the JEX format (Joplin Export file), which is a tar file that can contain multiple notes, notebooks, etc. This is a lossless format in that all the notes, but also metadata such as geo-location, updated time, tags, etc. are preserved. This format is convenient for backup purposes and can be re-imported into Joplin. A "raw" format is also available. This is the same as the JEX format except that the data is saved to a directory and each item represented by a single file.

    Synchronisation

    -

    One of the goals of Joplin was to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or OneDrive, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another or to even sync to multiple services at once. Each note, notebook, tags, as well as the relation between items is transmitted as plain text files during synchronisation, which means the data can also be moved to a different application, can be easily backed up, inspected, etc.

    -

    Currently, synchronisation is possible with Nextcloud and OneDrive (by default) or the local filesystem. A Dropbox one will also be available once this React Native bug is fixed. To setup synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on "Synchronise" to start a synchronisation manually.

    +

    One of the goals of Joplin was to avoid being tied to any particular company or service, whether it is Evernote, Google or Microsoft. As such the synchronisation is designed without any hard dependency to any particular service. Most of the synchronisation process is done at an abstract level and access to external services, such as Nextcloud or Dropbox, is done via lightweight drivers. It is easy to support new services by creating simple drivers that provide a filesystem-like interface, i.e. the ability to read, write, delete and list items. It is also simple to switch from one service to another or to even sync to multiple services at once. Each note, notebook, tags, as well as the relation between items is transmitted as plain text files during synchronisation, which means the data can also be moved to a different application, can be easily backed up, inspected, etc.

    +

    Currently, synchronisation is possible with Nextcloud, Dropbox (by default) or the local filesystem. To setup synchronisation please follow the instructions below. After that, the application will synchronise in the background whenever it is running, or you can click on "Synchronise" to start a synchronisation manually.

    Nextcloud synchronisation

    Nextcloud is a self-hosted, private cloud solution. It can store documents, images and videos but also calendars, passwords and countless other things and can sync them to your laptop or phone. As you can host your own Nextcloud server, you own both the data on your device and infrastructure used for synchronisation. As such it is a good fit for Joplin. The platform is also well supported and with a strong community, so it is likely to be around for a while - since it's open source anyway, it is not a service that can be closed, it can exist on a server for as long as one chooses.

    On the desktop application or mobile application, go to the config screen and select Nextcloud as the synchronisation target. Then input the WebDAV URL (to get it, click on Settings in the bottom left corner of the page, in Nextcloud), this is normally https://example.com/nextcloud/remote.php/webdav/Joplin (make sure to create the "Joplin" directory in Nextcloud), and set the username and password. If it does not work, please see this explanation for more details.

    @@ -325,7 +364,12 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin :config sync.5.password YOUR_PASSWORD :config sync.target 5

    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.

    -

    WebDAV synchronisation

    +

    Dropbox synchronisation

    +

    When syncing with Dropbox, Joplin creates a sub-directory in Dropbox, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.

    +

    On the desktop application or mobile application, select "Dropbox" as the synchronisation target in the config screen (it is selected by default). Then, to initiate the synchronisation process, click on the "Synchronise" button in the sidebar and follow the instructions.

    +

    On the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application. It is possible to also synchronise outside of the user interface by typing joplin sync from the terminal. This can be used to setup a cron script to synchronise at regular interval. For example, this would do it every 30 minutes:

    +
    */30 * * * * /path/to/joplin sync
+

    WebDAV synchronisation

    Select the "WebDAV" synchronisation target and follow the same instructions as for Nextcloud above.

    WebDAV-compatible services that are known to work with Joplin.

      @@ -339,10 +383,9 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin

    OneDrive synchronisation

    When syncing with OneDrive, Joplin creates a sub-directory in OneDrive, in /Apps/Joplin and read/write the notes and notebooks from it. The application does not have access to anything outside this directory.

    -

    On the desktop application or mobile application, select "OneDrive" as the synchronisation target in the config screen (it is selected by default). Then, to initiate the synchronisation process, click on the "Synchronise" button in the sidebar. You will be asked to login to OneDrive to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive).

    -

    On the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive). It is possible to also synchronise outside of the user interface by typing joplin sync from the terminal. This can be used to setup a cron script to synchronise at regular interval. For example, this would do it every 30 minutes:

    -
    */30 * * * * /path/to/joplin sync
-

    Encryption

    +

    On the desktop application or mobile application, select "OneDrive" as the synchronisation target in the config screen. Then, to initiate the synchronisation process, click on the "Synchronise" button in the sidebar and follow the instructions.

    +

    On the terminal application, to initiate the synchronisation process, type :sync. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive).

    +

    Encryption

    Joplin supports end-to-end encryption (E2EE) on all the applications. E2EE is a system where only the owner of the notes, notebooks, tags or resources can read them. It prevents potential eavesdroppers - including telecom providers, internet providers, and even the developers of Joplin from being able to access the data. Please see the End-To-End Encryption Tutorial for more information about this feature and how to enable it.

    For a more technical description, mostly relevant for development or to review the method being used, please see the Encryption specification.

    Attachments / Resources

    @@ -417,14 +460,14 @@ $$ Croatian hr_HR -Hrvoje Mandić trbuhom@net.hr +Hrvoje Mandić trbuhom@net.hr 62% Czech cs_CZ -Lukas Helebrandt lukas@aiya.cz +Lukas Helebrandt lukas@aiya.cz 97% @@ -438,7 +481,7 @@ $$ Deutsch de_DE -Tobias Grasse mail@tobias-grasse.net +Tobias Grasse mail@tobias-grasse.net 96% @@ -452,7 +495,7 @@ $$ Español es_ES -Fernando Martín f@mrtn.es +Fernando Martín f@mrtn.es 96% @@ -487,21 +530,21 @@ $$ Português (Brasil) pt_BR -Renato Nunes Bastos rnbastos@gmail.com +Renato Nunes Bastos rnbastos@gmail.com 95% Русский ru_RU -Artyom Karlov artyom.karlov@gmail.com +Artyom Karlov artyom.karlov@gmail.com 96% 中文 (简体) zh_CN -RCJacH RCJacH@outlook.com +RCJacH RCJacH@outlook.com 64% @@ -528,6 +571,8 @@ $$ +
    +Copyright (c) 2016-2018 Laurent Cozic +
    diff --git a/docs/mobile/index.html b/docs/mobile/index.html new file mode 100644 index 0000000000..5033c96b3a --- /dev/null +++ b/docs/mobile/index.html @@ -0,0 +1,285 @@ + + + + Joplin - an open source note taking and to-do application with synchronisation capabilities + + + + + + + + + + + + +
    + +
    + +

    oplin

    +

    An open source note taking and to-do application with synchronisation capabilities.

    +
    + +
    +
    + +
    + + + +
    +
    +
    + +
    + +

    An Android and iOS (iPhone/iPad) applications are available from the Joplin home page.

    + + + +
    +Copyright (c) 2016-2018 Laurent Cozic +
    + + diff --git a/docs/spec/index.html b/docs/spec/index.html index da92d2905b..f4d0c8c60b 100644 --- a/docs/spec/index.html +++ b/docs/spec/index.html @@ -47,6 +47,12 @@ pre { font-size: .85em; } + #toc ul { + margin-bottom: 10px; + } + #toc { + padding-bottom: 1em; + } .title-icon { height: 2em; } @@ -170,6 +176,13 @@ .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; @@ -195,8 +208,7 @@
    @@ -207,6 +219,33 @@
    +

    Encryption

    Encrypted data is encoded to ASCII because encryption/decryption functions in React Native can only deal with strings. So for compatibility with all the apps we need to use the lowest common denominator.

    Encrypted data format

    @@ -299,6 +338,8 @@ +
    +Copyright (c) 2016-2018 Laurent Cozic +
    diff --git a/docs/stats/index.html b/docs/stats/index.html index f8081d18ab..0c0ae8109d 100644 --- a/docs/stats/index.html +++ b/docs/stats/index.html @@ -47,6 +47,12 @@ pre { font-size: .85em; } + #toc ul { + margin-bottom: 10px; + } + #toc { + padding-bottom: 1em; + } .title-icon { height: 2em; } @@ -170,6 +176,13 @@ .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; @@ -195,8 +208,7 @@
    @@ -207,7 +219,34 @@
    -

    statistics

    + +

    Joplin statistics

    @@ -451,6 +490,8 @@ +
    +Copyright (c) 2016-2018 Laurent Cozic +
    diff --git a/docs/terminal/index.html b/docs/terminal/index.html index 39b1eb8e63..522b5932a4 100644 --- a/docs/terminal/index.html +++ b/docs/terminal/index.html @@ -47,6 +47,12 @@ pre { font-size: .85em; } + #toc ul { + margin-bottom: 10px; + } + #toc { + padding-bottom: 1em; + } .title-icon { height: 2em; } @@ -170,6 +176,13 @@ .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; @@ -195,8 +208,7 @@
    @@ -207,6 +219,34 @@
    + +

    Joplin

    Joplin is a free, open source note taking and to-do application, which can handle a large number of notes organised into notebooks. The notes are searchable, can be copied, tagged and modified with your own text editor.

    Notes exported from Evernote via .enex files can be imported into Joplin, including the formatted content (which is converted to Markdown), resources (images, attachments, etc.) and complete metadata (geolocation, updated time, created time, etc.). Plain Markdown files can also be imported.

    The notes can be synchronised with various targets including the file system (for example with a network directory) or with Microsoft OneDrive. When synchronising the notes, notebooks, tags and other metadata are saved to plain text files which can be easily inspected, backed up and moved around.

    @@ -296,6 +336,7 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin

    If the help is not fully visible, press Tab multiple times till the console is in focus and use the arrow keys or page up/down to scroll the text.

    +

    For general information relevant to all the applications, see also Joplin home page.

    Importing notes from Evernote

    To import Evernote data, follow these steps:

      @@ -495,8 +536,9 @@ Possible keys/values: locale Language. Type: Enum. Possible values: eu (Basque), hr_HR (Croatian), - de_DE (Deutsch), en_GB (English), es_ES - (Español), fr_FR (Français), it_IT (Italiano), + cs_CZ (Czech), da_DK (Dansk), de_DE (Deutsch), + en_GB (English), es_ES (Español), fr_FR + (Français), gl_ES (Galician), it_IT (Italiano), nl_BE (Nederlands), pt_BR (Português (Brasil)), ru_RU (Русский), zh_CN (中文 (简体)), ja_JP (日本語). Default: "en_GB" @@ -546,8 +588,8 @@ Possible keys/values: Type: Enum. Possible values: 2 (File system), 3 (OneDrive), 4 (OneDrive Dev (For testing only)), 5 (Nextcloud), - 6 (WebDAV). - Default: 3 + 6 (WebDAV), 7 (Dropbox). + Default: 7 sync.2.path Directory to synchronise with (absolute path). The path to synchronise with when file system @@ -710,6 +752,8 @@ version +
      +Copyright (c) 2016-2018 Laurent Cozic +
      diff --git a/readme/desktop.md b/readme/desktop.md index f8d02d3d4e..952030ebd3 100644 --- a/readme/desktop.md +++ b/readme/desktop.md @@ -1 +1,3 @@ - \ No newline at end of file + + +For general information relevant to all the applications, see also [Joplin home page](https://joplin.cozic.net). \ No newline at end of file diff --git a/readme/mobile.md b/readme/mobile.md new file mode 100644 index 0000000000..bb6de834f3 --- /dev/null +++ b/readme/mobile.md @@ -0,0 +1 @@ +An Android and iOS (iPhone/iPad) applications are available from the [Joplin home page](https://joplin.cozic.net). \ No newline at end of file diff --git a/readme/table_of_contents.md b/readme/table_of_contents.md new file mode 100644 index 0000000000..70b25f9a6a --- /dev/null +++ b/readme/table_of_contents.md @@ -0,0 +1,19 @@ +# Contents + +- Applications + + - [Desktop application](https://github.com/laurent22/joplin/blob/master/readme/desktop.md) + - [Mobile applications](https://github.com/laurent22/joplin/blob/master/readme/mobile.md) + - [Terminal application](https://github.com/laurent22/joplin/blob/master/readme/terminal.md) + +- Support + + - [How to enable end-to-end encryption](https://github.com/laurent22/joplin/blob/master/readme/e2ee.md) + - [End-to-end encryption spec](https://github.com/laurent22/joplin/blob/master/readme/spec.md) + - [How to enable debug mode](https://github.com/laurent22/joplin/blob/master/readme/debugging.md) + +- About + + - [Changelog](https://github.com/laurent22/joplin/blob/master/readme/changelog.md) + - [Stats](https://github.com/laurent22/joplin/blob/master/readme/stats.md) + - [Donate](https://github.com/laurent22/joplin/blob/master/readme/donate.md) \ No newline at end of file diff --git a/readme/terminal.md b/readme/terminal.md index 97283279ce..0b1021dd37 100644 --- a/readme/terminal.md +++ b/readme/terminal.md @@ -101,6 +101,8 @@ Command | Description If the help is not fully visible, press `Tab` multiple times till the console is in focus and use the arrow keys or page up/down to scroll the text. +For general information relevant to all the applications, see also [Joplin home page](https://joplin.cozic.net). + # Importing notes from Evernote To import Evernote data, follow these steps: @@ -283,8 +285,9 @@ The following commands are available in [command-line mode](#command-line-mode): locale Language. Type: Enum. Possible values: eu (Basque), hr_HR (Croatian), - de_DE (Deutsch), en_GB (English), es_ES - (Español), fr_FR (Français), it_IT (Italiano), + cs_CZ (Czech), da_DK (Dansk), de_DE (Deutsch), + en_GB (English), es_ES (Español), fr_FR + (Français), gl_ES (Galician), it_IT (Italiano), nl_BE (Nederlands), pt_BR (Português (Brasil)), ru_RU (Русский), zh_CN (中文 (简体)), ja_JP (日本語). Default: "en_GB" @@ -334,8 +337,8 @@ The following commands are available in [command-line mode](#command-line-mode): Type: Enum. Possible values: 2 (File system), 3 (OneDrive), 4 (OneDrive Dev (For testing only)), 5 (Nextcloud), - 6 (WebDAV). - Default: 3 + 6 (WebDAV), 7 (Dropbox). + Default: 7 sync.2.path Directory to synchronise with (absolute path). The path to synchronise with when file system