1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-11-27 08:21:03 +02:00

Updated doc

This commit is contained in:
Laurent Cozic 2019-02-05 18:46:32 +00:00
parent 735bc92bc4
commit 9f575101d2
6 changed files with 16 additions and 11 deletions

View File

@ -18,9 +18,9 @@ class WelcomeUtils {
const folderAssets = welcomeAssets.folders;
const tempDir = Setting.value('resourceDir');
// TODO: Update createResourceFromPath for mobile
// TODO: Update BaseApplication
// TODO: Update mobile root.js
// TODO: Finish Welcome notes
for (let i = 0; i < folderAssets.length; i++) {
const folderAsset = folderAssets[i];

View File

@ -53,6 +53,7 @@ const DropdownAlert = require('react-native-dropdownalert').default;
const ShareExtension = require('react-native-share-extension').default;
const ResourceFetcher = require('lib/services/ResourceFetcher');
const SearchEngine = require('lib/services/SearchEngine');
const WelcomeUtils = require('lib/WelcomeUtils');
const SyncTargetRegistry = require('lib/SyncTargetRegistry.js');
const SyncTargetOneDrive = require('lib/SyncTargetOneDrive.js');
@ -516,6 +517,8 @@ async function initialize(dispatch) {
DecryptionWorker.instance().scheduleStart();
});
await WelcomeUtils.createWelcomeItems();
reg.logger().info('Application initialized');
}

View File

@ -1,7 +1,9 @@
# Welcome to Joplin
# 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 applications directly or from your own text editor. The notes are in [Markdown format](https://joplin.cozic.net/#markdown). Joplin is available as **💻 desktop**, **📱 mobile** and **🔡 terminal** applications.
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, and they are not the differences will be clearly indicated.
![](./AllClients.png)
## Joplin is divided into three parts
@ -10,7 +12,7 @@ Joplin has three main columns:
- **Sidebar**: It contains the list of your notebooks and tags, as well as the synchronisation status.
- **Note List**: It contains the current list of notes - either the notes in the currently selected notebook, or the notes in the currently selected tag.
- **Note Editor**: The note editor contains both an editor panel, where your write your note in Markdown, and a viewer panel, which shows the rendered note. To edit notes, you may also use an [external editor](https://joplin.cozic.net/#external-text-editor). For example, if you like WYSIWYG editors, you can use something like Typora as an external editor and it will display the note as well as any embedded image.
- **Note Editor**: The note editor contains of course an actual editor, where your write your note in Markdown, and a viewer, which shows the rendered note. To edit notes, you may also use an [external editor](https://joplin.cozic.net/#external-text-editor). For example, if you like WYSIWYG editors, you can use something like Typora as an external editor and it will display the note as well as any embedded image.
## Writing notes in Markdown
@ -44,17 +46,17 @@ A lot more is possible including adding code samples, math formulaes or checkbox
## Organising your notes
### With notebooks
### With notebooks 📔
Joplin notes are organised into a tree of notebooks and sub-notebooks.
- On **💻 desktop**, you can create a notebook by clicking on New Notebook, then you can drag and drop them into other notebooks to organise them as you wish.
- On **📱 mobile**, press the "+" icon and select "New notebook".
- On **🔡 terminal**, press `:mn`!
- On **🔡 terminal**, press `:mn`
![](./SubNotebooks.png)
### With tags
### With tags 🏷️
The second way to organise your notes is using tags:

View File

@ -1,16 +1,16 @@
# Importing and exporting notes
# Importing and exporting notes ↔️
## Importing from Evernote
Joplin was designed as a replacement for Evernote and so 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. [More info about Evernote import](https://joplin.cozic.net/#importing-from-evernote) on the website.
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://joplin.cozic.net/#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).
# How to export notes
# 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.

View File

@ -1,4 +1,4 @@
# Synchronising your notes
# Synchronising your notes 🔄
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. You basically choose the service you prefer among those supported, setup the configuration, and the app will be able to sync between your computers or mobile devices.

View File

@ -1,4 +1,4 @@
# Tips
# Tips 💡
The first few notes should have given you an overview of the main functionalities in Joplin, but there's more it can do. See below for some of these features and how to get more help using the app: