From c72caad764e4d55aefbf7dae725282618f7442cb Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Sun, 26 Nov 2017 19:38:33 +0000 Subject: [PATCH] Updated website --- docs/index.html | 41 ++++++++++++++++------------------------- 1 file changed, 16 insertions(+), 25 deletions(-) diff --git a/docs/index.html b/docs/index.html index 3358916f83..9d747dfc3f 100644 --- a/docs/index.html +++ b/docs/index.html @@ -199,14 +199,14 @@
-

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.).

+

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.).

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.

Joplin is still under development but is out of Beta and should be suitable for every day use. 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.

Installation

-

Three types of applications are available: desktop (Windows, macOS and Linux), mobile (Android and iOS) and for terminal (Windows, macOS and Linux). All applications have similar user interfaces and can synchronise with each others.

+

Three types of applications are available: for the desktop (Windows, macOS and Linux), for mobile (Android and iOS) and for terminal (Windows, macOS and Linux). All applications have similar user interfaces and can synchronise with each others.

Desktop applications

@@ -218,15 +218,15 @@ - + - + - +
WindowsGet it on WindowsGet it on Windows
macOSGet it on macOSGet it on macOS
LinuxGet it on macOSGet it on macOS
@@ -252,7 +252,8 @@

Terminal application

On macOS, Linux or Windows (via WSL), type:

npm install -g joplin
-

To start it, type joplin.

+

If the application does not install due to permission issues, please make sure that your global npm permissions are correct by following the instructions here.

+

To start it, type joplin.

For usage information, please refer to the full Joplin Terminal Application Documentation.

Features

-

To import Evernote data, follow these steps:

-

Desktop application

- -

This will open a new screen which will display the import progress. The notes will be imported into a new separate notebook (so that, in case of a mistake, the notes are not mixed up with any existing notes). If needed then can then be moved to a different notebook, or the notebook can be renamed, etc.

-

Terminal application

- +

To import Evernote data, first export your Evernote notebooks to ENEX files as described here. Then follow these steps:

+

On the desktop application, open the "File" menu, click "Import Evernote notes" and select your ENEX file. This will open a new screen which will display the import progress. The notes will be imported into a new separate notebook (so that, in case of a mistake, the notes are not mixed up with any existing notes). If needed then can then be moved to a different notebook, or the notebook can be renamed, etc.

+

On the desktop application, in command-line mode, type import-enex /path/to/file.enex. This will import the notes into a new notebook named after the filename.

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 OneDrive 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 OneDrive (by default) or the local filesystem. A Dropbox driver will also be available once this React Native bug is fixed. 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.

-

Desktop application

-

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). After that, the application will synchronise in the background whenever it is running, or you can click on "Synchronise" to start a synchronisation manually

-

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). After that, the application will synchronise in the background whenever it is running. 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:

+

On the desktop application, 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). After that, the application will synchronise in the background whenever it is running, or you can click on "Synchronise" to start a synchronisation manually.

+

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). After that, the application will synchronise in the background whenever it is running. 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

Attachments / Resources

Any kind of file can be attached to a note. In Markdown, links to these files are represented as a simple ID to the resource. In the note viewer, these files, if they are images, will be displayed or, if they are other files (PDF, text files, etc.) they will be displayed as links. Clicking on this link will open the file in the default application.

@@ -306,7 +296,7 @@
  • In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change "Country" and "Language" to your own country and language.
  • From then you can translate the file. Once it's done, please send the file to this address or open a pull request.
    • -

    This translation will apply to both the terminal and the Android application.

    +

    This translation will apply to the three applications - desktop, mobile and terminal.

    Coming features