mirror of
https://github.com/laurent22/joplin.git
synced 2026-06-18 20:16:34 +02:00
Doc: Refactored documentation, split it into smaller articles, and added search (#9132)
This commit is contained in:
Laurent Cozic
@@ -1,6 +1,6 @@
|
||||
# Welcome to Joplin!
|
||||
|
||||
Joplin is a free, open source note taking and to-do application, which helps you write and organise your notes, and synchronise them between your devices. The notes are searchable, can be copied, tagged and modified either from the application directly or from your own text editor. The notes are in [Markdown format](https://joplinapp.org/help/#markdown). Joplin is available as a **desktop**, **mobile** and **terminal** application.
|
||||
Joplin is a free, open source note taking and to-do application, which helps you write and organise your notes, and synchronise them between your devices. The notes are searchable, can be copied, tagged and modified either from the application directly or from your own text editor. The notes are in [Markdown format](https://joplinapp.org/help/apps/markdown). Joplin is available as a **desktop**, **mobile** and **terminal** application.
|
||||
|
||||
The notes in this notebook give an overview of what Joplin can do and how to use it. In general, the three applications share roughly the same functionalities; any differences will be clearly indicated.
|
||||
|
||||
@@ -14,11 +14,11 @@ Joplin has three main columns:
|
||||
|
||||
- **Note List** contains the current list of notes - either the notes in the currently selected notebook, the notes in the currently selected tag, or search results.
|
||||
|
||||
- **Note Editor** is the place where you write your notes. There is a **Rich Text editor** and a **Markdown editor** - click on the **Toggle editor** button in the top right hand corner to switch between both! You may also use an [external editor](https://joplinapp.org/help/#external-text-editor) to edit notes. For example you can use Typora as an external editor and it will display the note as well as any embedded images.
|
||||
- **Note Editor** is the place where you write your notes. There is a **Rich Text editor** and a **Markdown editor** - click on the **Toggle editor** button in the top right hand corner to switch between both! You may also use an [external editor](https://joplinapp.org/help/apps/external_text_editor) to edit notes. For example you can use Typora as an external editor and it will display the note as well as any embedded images.
|
||||
|
||||
## Writing notes in Markdown
|
||||
|
||||
Markdown is a lightweight markup language with plain text formatting syntax. Joplin supports a [Github-flavoured Markdown syntax](https://joplinapp.org/markdown/) with a few variations and additions.
|
||||
Markdown is a lightweight markup language with plain text formatting syntax. Joplin supports a [Github-flavoured Markdown syntax](https://joplinapp.org/help/apps/markdown) with a few variations and additions.
|
||||
|
||||
In general, while Markdown is a markup language, it is meant to be human readable, even without being rendered. This is a simple example (you can see how it looks in the viewer panel):
|
||||
|
||||
@@ -44,7 +44,7 @@ This is a [link](https://joplinapp.org) and, finally, below is a horizontal rule
|
||||
|
||||
* * *
|
||||
|
||||
A lot more is possible including adding code samples, math formulae or checkbox lists - see the [Markdown documentation](https://joplinapp.org/help/#markdown) for more information.
|
||||
A lot more is possible including adding code samples, math formulae or checkbox lists - see the [Markdown documentation](https://joplinapp.org/help/apps/markdown) for more information.
|
||||
|
||||
## Organising your notes
|
||||
|
||||
|
||||
@@ -4,12 +4,12 @@
|
||||
|
||||
Joplin can import complete Evernote notebooks, as well as notes, tags, images, attached files and note metadata (such as author, geo-location, etc.) via ENEX files.
|
||||
|
||||
To import Evernote data, first export your Evernote notebooks to ENEX files as described [here](https://help.evernote.com/hc/en-us/articles/209005557-How-to-back-up-export-and-restore-import-notes-and-notebooks). Then, on **desktop**, do the following: 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. Read [more about Evernote import](https://joplinapp.org/help/#importing-from-evernote).
|
||||
To import Evernote data, first export your Evernote notebooks to ENEX files as described [here](https://help.evernote.com/hc/en-us/articles/209005557-How-to-back-up-export-and-restore-import-notes-and-notebooks). Then, on **desktop**, do the following: 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. Read [more about Evernote import](https://joplinapp.org/help/apps/import_export#importing-from-evernote).
|
||||
|
||||
# Importing from other apps
|
||||
|
||||
Joplin can also import notes from [many other apps](https://github.com/laurent22/joplin#importing-from-other-applications) as well as [from Markdown or text files](https://github.com/laurent22/joplin#importing-from-markdown-files).
|
||||
Joplin can also import notes from [many other apps](https://joplinapp.org/help/apps/import_export#importing-from-other-applications) as well as [from Markdown or text files](https://joplinapp.org/help/apps/import_export#importing-from-markdown-files).
|
||||
|
||||
# Exporting notes
|
||||
|
||||
Joplin can export to the JEX format (Joplin Export file), which is an archive that can contain multiple notes, notebooks, etc. This is a format mostly designed for backup purposes. You may also export to other formats such as plain Markdown files, to JSON or to PDF. Find out [more about exporting notes](https://github.com/laurent22/joplin#exporting) on the official website.
|
||||
Joplin can export to the JEX format (Joplin Export file), which is an archive that can contain multiple notes, notebooks, etc. This is a format mostly designed for backup purposes. You may also export to other formats such as plain Markdown files, to JSON or to PDF. Find out [more about exporting notes](https://joplinapp.org/help/apps/import_export#exporting) on the official website.
|
||||
@@ -22,4 +22,4 @@ OneDrive and WebDAV are also supported as synchronisation services. Please see [
|
||||
|
||||
## Using End-To-End Encryption
|
||||
|
||||
Joplin supports end-to-end encryption (E2EE) on all the applications. E2EE is a system where only the owner of the data 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. Please see the [End-To-End Encryption Tutorial](https://joplinapp.org/e2ee/) for more information about this feature and how to enable it.
|
||||
Joplin supports end-to-end encryption (E2EE) on all the applications. E2EE is a system where only the owner of the data 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. Please see the [End-To-End Encryption Tutorial](https://joplinapp.org/help/apps/sync/e2ee) for more information about this feature and how to enable it.
|
||||
|
||||
@@ -8,7 +8,7 @@ The first few notes should have given you an overview of the main functionalitie
|
||||
|
||||
The Web Clipper is a browser extension that allows you to save web pages and screenshots from your browser. To start using it, open the Joplin desktop application, go to the Web Clipper Options and follow the instructions.
|
||||
|
||||
More info on the official website: https://joplinapp.org/clipper/
|
||||
More info on the official website: https://joplinapp.org/help/apps/clipper
|
||||
|
||||
## Plugins
|
||||
|
||||
@@ -20,19 +20,19 @@ Any kind of file can be attached to a note. In Markdown, links to these files ar
|
||||
|
||||
Images can be attached either by clicking on "Attach file" or by pasting (with `Ctrl+V` or `Cmd+V`) an image directly in the editor, or by drag and dropping an image.
|
||||
|
||||
More info about attachments: https://joplinapp.org/help/#attachments
|
||||
More info about attachments: https://joplinapp.org/help/apps/attachments
|
||||
|
||||
## Search
|
||||
|
||||
Joplin supports advanced search queries, which are fully documented on the official website: https://joplinapp.org/help/#searching
|
||||
Joplin supports advanced search queries, which are fully documented on the official website: https://joplinapp.org/help/apps/search
|
||||
|
||||
## Alarms
|
||||
|
||||
An alarm can be associated with any to-do. It will be triggered at the given time by displaying a notification. To use this feature, see the documentation: https://joplinapp.org/help/#notifications
|
||||
An alarm can be associated with any to-do. It will be triggered at the given time by displaying a notification. To use this feature, see the documentation: https://joplinapp.org/help/apps/notifications
|
||||
|
||||
## Markdown advanced tips
|
||||
|
||||
Joplin uses and renders [Github-flavoured Markdown](https://joplinapp.org/markdown/) with a few variations and additions.
|
||||
Joplin uses and renders [Github-flavoured Markdown](https://joplinapp.org/help/apps/markdown) with a few variations and additions.
|
||||
|
||||
For example, tables are supported:
|
||||
|
||||
@@ -56,7 +56,7 @@ f(x) = \int_{-\infty}^\infty
|
||||
\,d\xi
|
||||
$$
|
||||
|
||||
Various other tricks are possible, such as using HTML, or customising the CSS. See the Markdown documentation for more info - https://joplinapp.org/markdown/
|
||||
Various other tricks are possible, such as using HTML, or customising the CSS. See the Markdown documentation for more info - https://joplinapp.org/help/apps/markdown
|
||||
|
||||
## Community and further help
|
||||
|
||||
|
||||
Reference in New Issue
Block a user