oplin

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

Donate Become a patron

Hacktoberfest is back this year again for our great pleasure ^^

here are the rules to participate:

To qualify for the official limited edition Hacktoberfest shirt, you must register and make four pull requests (PRs) between October 1-31 (in any time zone). PRs can be made to any public repo on GitHub, not only the ones with issues labeled Hacktoberfest. This year, the first 50,000 participants who successfully complete the challenge will earn a T-shirt.

To participate go to https://hacktoberfest.digitalocean.com/, log in (with you GitHub account) and you are ready to get in.

Next, go dive into the Joplin issues list labelled "Hacktoberfest"

Start hacking, submit the PR from the 1st of October, not before.

We hope you will enjoy that event this year again like the previous one :jack_o_lantern: :tada:

PS: the 4 Pull Request donโ€™t have to be done only on Joplin project, those can be done on any FOSS projects. Even PR for issue not tagged as 'hacktoberfest'

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, Dropbox, OneDrive, WebDAV 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 application is available for Windows, Linux, macOS, Android and iOS (the terminal app also works on FreeBSD). A Web Clipper, to save web pages and screenshots from your browser, is also available for Firefox and Chrome.

๐Ÿ”—Installation

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

๐Ÿ”—Desktop applications

Operating System Download Alternative
Windows (32 and 64-bit) Get it on Windows Or get the Portable version

The portable application allows installing the software on a portable device such as a USB key. Simply copy the file JoplinPortable.exe in any directory on that USB key ; the application will then create a directory called "JoplinProfile" next to the executable file.
macOS Get it on macOS You can also use Homebrew: brew cask install joplin
Linux Get it on Linux An Arch Linux package is also available.

If it works with your distribution (it has been tested on Ubuntu, Fedora, Gnome and Mint), the recommended way is to use this script as it will handle the desktop icon too:

wget -O - https://raw.githubusercontent.com/laurent22/joplin/master/Joplin_install_and_update.sh | bash

๐Ÿ”—Mobile applications

Operating System Download Alt. Download
Android Get it on Google Play or download the APK file: 64-bit 32-bit
iOS Get it on the App Store -

๐Ÿ”—Terminal application

Operating system Method
macOS brew install joplin
Linux or Windows (via WSL) Important: First, install Node 8+.

NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin
sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin

By default, the application binary will be installed under ~/.joplin-bin. You may change this directory if needed. Alternatively, if your npm permissions are setup as described here (Option 2) then simply running npm -g install joplin would work.
Arch Linux An Arch Linux package is available here. To install it, use an AUR wrapper such as yay: yay -S joplin. Both the CLI tool (type joplin) and desktop app (type joplin-desktop) are packaged. For support, please go to the GitHub repo.

To start it, type joplin.

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

๐Ÿ”—Web Clipper

The Web Clipper is a browser extension that allows you to save web pages and screenshots from your browser. For more information on how to install and use it, see the Web Clipper Help Page.

๐Ÿ”—Features

๐Ÿ”—Importing

๐Ÿ”—Importing from Evernote

Joplin was designed as a replacement for Evernote and so can import complete Evernote notebooks, as well as notes, tags, resources (attached files) and note metadata (such as author, geo-location, etc.) via ENEX files. In terms of data, the only two things that might slightly differ are:

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

In the desktop application, open File > Import > ENEX and select your file. The notes will be imported into a new separate notebook. If needed they can then be moved to a different notebook, or the notebook can be renamed, etc.

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

๐Ÿ”—Importing from Markdown files

Joplin can import notes from plain Markdown file. You can either import a complete directory of Markdown files or individual files.

In the desktop application, open File > Import > MD and select your Markdown file or directory.

In the terminal application, in command-line mode, type import --format md /path/to/file.md or import --format md /path/to/directory/.

๐Ÿ”—Importing from other applications

In general the way to import notes from any application into Joplin is to convert the notes to ENEX files (Evernote format) and to import these ENEX files into Joplin using the method above. Most note-taking applications support ENEX files so it should be relatively straightforward. For help about specific applications, see below:

๐Ÿ”—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 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), OneDrive 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.

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

In 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/webdav/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.

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

In 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:

๐Ÿ”—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.

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

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

๐Ÿ”—Note history

The Joplin applications automatically save previous versions of your notes at regular intervals. These versions are synced across devices and can be viewed from the desktop application. To do so, click on the "Information" button on a note, then click on "Previous version of this note". From this screen you can view the previous versions of the note as well as restore any of them.

This feature can be disabled from the "Note history" section in the settings, and it is also possible to change for how long the history of a note is saved.

More information about this feature in the announcement post.

๐Ÿ”—External text editor

Joplin notes can be opened and edited using an external editor of your choice. It can be a simple text editor like Notepad++ or Sublime Text or an actual Markdown editor like Typora. In that case, images will also be displayed within the editor. To open the note in an external editor, click on the icon in the toolbar or press Ctrl+E (or Cmd+E). Your default text editor will be used to open the note. If needed, you can also specify the editor directly in the General Options, under "Text editor command".

๐Ÿ”—Attachments

Any kind of file can be attached to a note. In Markdown, links to these files are represented as a simple ID to the attachment. 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.

In the desktop application, files can be attached either by clicking the "Attach file" icon in the editor or via drag and drop. If you prefer to create a link to a local file instead, hold the ALT key while performing the drag and drop operation.
If the OS-clipboard contains an image you can directly paste it in the editor via Ctrl+V.

Resources that are not attached to any note will be automatically deleted after 10 days (see rationale).

Important: Resources larger than 10 MB are not currently supported on mobile. They will crash the application when synchronising so it is recommended not to attach such resources at the moment. The issue is being looked at.

๐Ÿ”—Downloading attachments

The way the attachments are downloaded during synchronisation can be customised in the Configuration screen, under "Attachment download behaviour". The default option ("Always") is to download all the attachments, all the time, so that the data is available even when the device is offline. There is also the option to download the attachments manually (option "Manual"), by clicking on it, or automatically (Option "Auto"), in which case the attachments are downloaded only when a note is opened. These options should help saving disk space and network bandwidth, especially on mobile.

๐Ÿ”—Notifications

In the desktop and mobile apps, an alarm can be associated with any to-do. It will be triggered at the given time by displaying a notification. How the notification will be displayed depends on the operating system since each has a different way to handle this. Please see below for the requirements for the desktop applications:

See documentation and flow chart for reporter choice

On mobile, the alarms will be displayed using the built-in notification system.

If for any reason the notifications do not work, please open an issue.

๐Ÿ”—Sub-notebooks

Sub-notebooks allow organising multiple notebooks into a tree of notebooks. For example it can be used to regroup all the notebooks related to work, to family or to a particular project under a parent notebook.

๐Ÿ”—Markdown

Joplin uses and renders Github-flavoured Markdown with a few variations and additions. In particular:

๐Ÿ”—Links to other notes

You can create a link to a note by specifying its ID in the URL. For example:

[Link to my note](:/0b0d62d15e60409dac34f354b6e9e839)

Since getting the ID of a note is not straightforward, each app provides a way to create such link. In the desktop app, right click on a note an select "Copy Markdown link". In the mobile app, open a note and, in the top right menu, select "Copy Markdown link". You can then paste this link anywhere in another note.

๐Ÿ”—Plugins

Joplin supports a number of plugins that can be toggled on top the standard markdown features you would expect. These toggle-able plugins are listed below. Note: not all of the plugins are enabled by default, if the enable field is 'no' below, then enter Tools->General Options to enable the plugin. Plugins can be disabled in the same manner.

Plugin Syntax Description Enabled
Katex $$math expr$$ or $math$ See Below yes
Mark ==marked== Transforms into <mark>marked</mark> (highlighted) yes
Footnote Simples inline footnote ^[I'm inline!] See plugin page for full description yes
TOC Any of ${toc}, [[toc]], [toc], [[_toc_]] Adds a table of contents to the location of the toc page. Based on headings and sub-headings no
Sub X~1~ Transforms into X1 no
Sup X^2^ Transforms into X2 no
Deflist See pandoc page for syntax Adds the html <dl> tag accessible through markdown no
Abbr *[HTML]: Hyper Text Markup Language Allows definition of abbreviations that can be hovered over later for a full expansion no
Emoji :smile: :smile: See this list for more emoji no
Insert ++inserted++ Transforms into <ins>inserted</ins> (inserted) no
Multitable See MultiMarkdown page Adds more power and customization to markdown tables no
Fountain ```fountain
Your screenplay...
```		 Adds support for the Fountain markup language, a plain text markup language for screenwriting no

๐Ÿ”—Math notation

Math expressions can be added using the KaTeX notation. 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
$$

For example:

$$
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:

๐Ÿ”—Checkboxes

Checkboxes can be added like so:

- [ ] Milk
- [ ] Rice
- [ ] Eggs

The checkboxes can then be ticked in the mobile and desktop applications.

๐Ÿ”—HTML support

It is generally recommended to enter the notes as Markdown as it makes the notes easier to edit. However for cases where certain features aren't supported (such as strikethrough or to highlight text), you can also use HTML code directly. For example this would be a valid note:

This is <s>strikethrough text</s> mixed with regular **Markdown**.

๐Ÿ”—Custom CSS

Rendered markdown can be customized by placing a userstyle file in the profile directory ~/.config/joplin-desktop/userstyle.css (This path might be different on your device - check at the top of the Config screen for the exact path). This file supports standard CSS syntax. Joplin must be restarted for the new css to be applied, please ensure that Joplin is not closing to the tray, but is actually exiting. Note that this file is used only when display the notes, not when printing or exporting to PDF. This is because printing has a lot more restrictions (for example, printing white text over a black background is usually not wanted), so special rules are applied to make it look good when printing, and a userstyle.css would interfer with that.

๐Ÿ”—Note templates

In the desktop app, templates can be used to create new notes or to insert into existing ones by creating a templates folder in Joplin's config folder and placing Markdown template files into it. For example creating the file hours.md in the templates directory with the contents:

Date: {{date}}
Hours:
Details:

Templates can then be inserted from the menu (File->Templates).

The currently supported template variables are:

Variable Description Example
{{date}} Today's date formatted based on the settings format 2019-01-01
{{time}} Current time formatted based on the settings format 13:00
{{datetime}} Current date and time formatted based on the settings format 01/01/19 1:00 PM
{{#custom_datetime}} Current date and/or time formatted based on a supplied string (using moment.js formatting) {{#custom_datetime}}M d{{/custom_datetime}}

๐Ÿ”—Searching

Joplin implements the SQLite Full Text Search (FTS4) extension. It means the content of all the notes is indexed in real time and search queries return results very fast. Both Simple FTS Queries and Full-Text Index Queries are supported. See below for the list of supported queries:

Search type Description Example
Single word Returns all the notes that contain this term. For example, searching for cat will return all the notes that contain this exact word. Note: it will not return the notes that contain the substring - thus, for "cat", notes that contain "cataclysmic" or "prevaricate" will not be returned.
Multiples words Returns all the notes that contain all these words, but not necessarily next to each other. dog cat - will return any notes that contain the words "dog" and "cat" anywhere in the note, no necessarily in that order nor next to each other. It will not return results that contain "dog" or "cat" only.
Phrase query Add double quotes to return the notes that contain exactly this phrase. "shopping list" - will return the notes that contain these exact terms next to each other and in this order. It will not return for example a note that contains "going shopping with my list".
Prefix Add a wildcard to return all the notes that contain a term with a specified prefix. swim* - will return all the notes that contain eg. "swim", but also "swimming", "swimsuit", etc. IMPORTANT: The wildcard can only be at the end - it will be ignored at the beginning of a word (eg. *swim) and will be treated as a literal asterisk in the middle of a word (eg. ast*rix)
Field restricted Add either title: or body: before a note to restrict your search to just the title, or just the body. title:shopping, body:egg

Notes are sorted by "relevance". Currently it means the notes that contain the requested terms the most times are on top. For queries with multiple terms, it also matters how close to each other the terms are. This is a bit experimental so if you notice a search query that returns unexpected results, please report it in the forum, providing as many details as possible to replicate the issue.

๐Ÿ”—Goto Anything

In the desktop application, press Ctrl+G or Cmd+G and type the title of a note to jump directly to it. You can also type # followed by a tag or @ followed by a notebook title.

๐Ÿ”—Donations

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.

Please see the donation page for information on how to support the development of Joplin.

๐Ÿ”—Community

๐Ÿ”—Contributing

Please see the guide for information on how to contribute to the development of Joplin: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md

๐Ÿ”—Localisation

Joplin is currently available in the languages below. If you would like to contribute a new translation, it is quite straightforward, please follow these steps:

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

To update a translation, follow the same steps as above but instead of getting the .pot file, get the .po file for your language from the table below.

Current translations:

ย  Language Po File Last translator Percent done
Arabic ar ุนุจุฏ ุงู„ู†ุงุตุฑ ุณุนูŠุฏ (as@althobaity.com) 83%
Basque eu juan.abasolo@ehu.eus 47%
Bulgarian bg_BG 91%
Catalan ca jmontane, 2019 72%
Croatian hr_HR Hrvoje Mandiฤ‡ (trbuhom@net.hr) 38%
Czech cs_CZ Lukas Helebrandt (lukas@aiya.cz) 84%
Dansk da_DK Morten Juhl-Johansen Zรถlde-Fejรฉr (mjjzf@syntaktisk. 61%
Deutsch de_DE Michael Sonntag (ms@editorei.de) 96%
English (UK) en_GB 100%
English (US) en_US 100%
Espaรฑol es_ES Andros Fenollosa (andros@fenollosa.email) 90%
Franรงais fr_FR Laurent Cozic 100%
Galician gl_ES Marcos Lans (marcoslansgarza@gmail.com) 59%
Italiano it_IT 95%
Nederlands nl_BE 47%
Nederlands nl_NL Heimen Stoffels (vistausss@outlook.com) 94%
Norwegian nb_NO Mats Estensen (code@mxe.no) 84%
Persian fa Mehrad Mahmoudian (mehrad@mahmoudian.me) 45%
Polski pl_PL 90%
Portuguรชs (Brasil) pt_BR Rafael Teixeira (rto.tinfo@gmail.com) 93%
Romรขnฤƒ ro 47%
Slovenian sl_SI 59%
Svenska sv Jonatan Nyberg (jonatan@autistici.org) 80%
Tรผrkรงe tr_TR Zorbey DoฤŸangรผneลŸ (zorbeyd@gmail.com) 78%
ะ ัƒััะบะธะน ru_RU Artyom Karlov (artyom.karlov@gmail.com) 83%
ัั€ะฟัะบะธ ั˜ะตะทะธะบ sr_RS 90%
ไธญๆ–‡ (็ฎ€ไฝ“) zh_CN 98%
ไธญๆ–‡ (็น้ซ”) zh_TW penguinsam (samliu@gmail.com) 72%
ๆ—ฅๆœฌ่ชž ja_JP AWASHIRO Ikuya (ikunya@gmail.com) 98%
ํ•œ๊ตญ๋ง ko 98%

๐Ÿ”—Sponsors

Thanks to our GitHub sponsors!

devonzuegel
corvus-ch

๐Ÿ”—Contributors

laurent22
tessus
CalebJohn
tanrax
rtmkrlv

fmrtn
gabcoh
Abijeet
innocuo
matsest

abonte
foxmask
marcosvega91
petrz12
alexdevero

moltenform
devonzuegel
zuphilip
0ndrey
stweil

readingsnail
archont00
bradmcl
tfinnberg
RaphaelKimmig

RenatoXSR
sensor-freak
zblesk
chrisb86
jmontane

solariz
mmahmoudian
maicki
mjjzf
rt-oliveira

metbril
sebastienjust
ShaneKilkelly
Zorbeyd
chenlhlinux

pf-siedler
ruuti
s1nceri7y
ShuiHuo
ikunya

Shaxine
bimlas
chaifeng
charles-e
chrmoritz

donbowman
dflock
einverne
Atalanttore
eodeluga

FleischKarussel
gmag11
gusbemacbe
Fvbor
sczhg

Vistaus
JOJ0
jacobherrington
jaredcrowe
JoelRSimpson

jony0008
joybinchen
y-usuzumi
xuhcc
kklas

lboullo0
dbinary
mvonmaltitz
Marmo
mgroth0

MichipX
MrTraduttore
NJannasch
Ouvill
shorty2380

Diadlo
Cogitri
ruzaq
SamuelBlickle
kcrt

xissy
Tekki
tbroadley
Kriechi
tkilaker

tcyrus
tobias-grasse
strobeltobias
ymitsos
axq

cdorin93
cybertramp
delta-emil
doc75
ebayer

rasperepodvipodvert
genneko
hydrandt
pensierocrea
rhtenhove

simonsan
stellarpower
sumomo-99
tcassaert
xcffl

zhangmx

๐Ÿ”—Known bugs

๐Ÿ”—License

MIT License

Copyright (c) 2016-2019 Laurent Cozic

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Copyright (c) 2016-2019 Laurent Cozic