diff --git a/README.md b/README.md index 86ff47b3df..0c235c77b6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The notes can be [synchronised](#synchronisation) with various cloud services in 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/). -
+ # Installation @@ -20,16 +20,16 @@ Three types of applications are available: for the **desktop** (Windows, macOS a Operating System | Download -----------------|-------- -Windows (64-bit only) | -macOS | -Linux | +Windows (64-bit only) | +macOS | +Linux | ## Mobile applications Operating System | Download | Alt. Download -----------------|----------|---------------- -Android | | or [Download APK File](https://github.com/laurent22/joplin-android/releases/download/android-v1.0.115/joplin-v1.0.115.apk) -iOS | | - +Android | | or [Download APK File](https://github.com/laurent22/joplin-android/releases/download/android-v1.0.115/joplin-v1.0.115.apk) +iOS | | - ## Terminal application @@ -133,7 +133,7 @@ Currently, synchronisation is possible with Nextcloud, Dropbox (by default) or t ## 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. + 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](https://github.com/laurent22/joplin/issues/61#issuecomment-373282608) for more details. @@ -224,7 +224,7 @@ For example: Here is an example with the Markdown and rendered result side by side: - + ## Checkboxes diff --git a/docs/index.html b/docs/index.html index 96fabb1365..805ade63bc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -251,7 +251,7 @@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, 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.
- +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.
@@ -266,15 +266,15 @@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 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.
+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.
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
@@ -414,7 +414,7 @@ f(x) = \int_{-\infty}^\infty
\,d\xi
$$
Here is an example with the Markdown and rendered result side by side:
- +Checkboxes can be added like so:
- [ ] Milk
@@ -460,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%
@@ -481,7 +481,7 @@ $$
Deutsch
de_DE
-Tobias Grasse mail@tobias-grasse.net
+Tobias Grasse mail@tobias-grasse.net
96%
@@ -495,7 +495,7 @@ $$
Español
es_ES
-Fernando Martín f@mrtn.es
+Fernando Martín f@mrtn.es
96%
@@ -530,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%