Home / GitHub Page

Joplin's vscode plugin is released!

joplin-vscode-plugin

English, 简体中文

The integration of joplin in VSCode currently allows direct operations on directories and notes, while supporting the search function.

Features

  • There is a tab in VSCode to show the directory tree
  • Create/update/delete directories/notes in VSCode
  • Click and edit directly in VSCode
  • Search all notes in VSCode

Requirements

Extension Settings

  • joplin.token: token for joplin web service
  • joplin.port: port of joplin web service, default is 41184

Known Issues

  • Lack of shortcut key support

Release Notes

0.1.2

  • When activating Joplin for vscode, first call the ping interface once, if it fails, add obvious error message

0.1.1

  • Update instructions, add screenshots

0.1.0

  • Open directly after creating notes
  • Turn off sync after closing notes
  • The directory tree in VSCode is automatically updated regularly when doing operations on directories/notes in Joplin
  • Add development environment variables
  • Support internationalization
  • Replace icon with joplin

0.0.1

  • There is a tab in VSCode to show the directory tree
  • Create/update/delete directories/notes in VSCode
  • Click and edit directly in VSCode
  • Search all notes in VSCode

Use Markdown

Note: You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

  • Split the editor (Cmd+\ on macOS or Ctrl+\ on Windows and Linux)
  • Toggle preview (Shift+CMD+V on macOS or Shift+Ctrl+V on Windows and Linux)
  • Press Ctrl+Space (Windows, Linux) or Cmd+Space (macOS) to see a list of Markdown snippets

For more information

Enjoy!

FAQ

Show error message Joplin’s token/port is set incorrectly, unable to access Joplin service!

Please try to execute the following command in CMD/Bash, if there is no problem, it should return JoplinClipperServer, otherwise you need File an issue with Joplin.

curl http://127.0.0.1:41184/ping

Not opened in VSCode after clicking

Please refer to the official default external editor settings: How can I edit my note in an external text editor?

No list displayed in the sidebar

After checking joplin configuration items, restart VSCode.

Clicking on the sidebar fails to open the note

Please use the last version v1.0.224, because it contains several new APIs, such as opening notes according to noteId in VSCode .

12 Likes

Why write this plugin for vscode

  1. As a professional editor, the editing function of vscode is unmatched by the note-taking tool. For example, shortcut key support
  2. Vscode is not only an editor, but also has a very large plug-in ecosystem, so it has already been implemented in markdown formatting, linter verification, pdf export and other functions. There is no need to re-create the wheel in the note tool - it is possible Is a square wheel
  3. In fact, I have been using vscode to edit markdown documents, and git + vscode to store company-related documents. At the same time, joplin is also used to store personal notes, but after a while, I found that I need to edit vscode + the synchronization/search function of joplin.

So I wrote this plugin for people who have the same needs as me.


In addition, I hope that joplin adds the concept of workspace to be able to distinguish company/personal notes/documents


I will add some error tips later

5 Likes

Morning! This looks really interesting! Before I install this (since I’m currently at work and not home), does this work even when Joplin is encrypted?

As long as you can manipulate data from joplin’s web api, it should work properly (assuming you install the Web Clipper plug-in can work normally), of course, you can also install and test it, if there are any problems, please directly @me

1 Like

How do I connect VSC to Joplin? I get an error
connect ECONNREFUSED

  1. Joplin needs to open Service
  2. VSCode set joplin.token
  3. Restart VSCode


If you still have any questions, please continue to reply here, thank you

This didn’t work. It works for the browser (chrome) but not for my VSC. Maybe that’s because I’m using a newer version?
Joplin 1.0.220 (prod, win32)

Can you see the icon in the sidebar? If yes, can you see the list of notes?

If you don’t see the icon in the sidebar, you may need to update vscode and reinstall the plugin. Otherwise, if you can’t see the directory listing, then the port may be wrong.

It now suddenly worked after i’ve put in the port number again - the same number as it was in, just retyped it in as I also suspected there was a problem with port because the error message referenced to another port. This even though that the port in the setting was correct. I suspect that there might be a formatting problem in the port section in vsc.

No, I think it may be that you have not restarted VSCode. At present, you must restart VSCode after installing the extension for configuration to reload the entire plugin. This is a problem, but it may not be solved so quickly. . .

In addition, I think you may need to use the pre-release v1.0.224, because it contains several new APIs, such as opening notes in VSCode according to noteId.

I did restart it several times.
Anyways, after I saw the folders, I tried to get to the notes but I couldn’t. After another restart, it again didn’t work. This time, I’ve received following more clear error, but I’ve checked several times – it should be correct.

Joplin’s token/port is set incorrectly, unable to access Joplin service!

Just saw your new message above. This makes more sense. I’ll wait until I’ll get the pre-release version :). I’ll come back to you when it arrives on my computer :slight_smile:

I tried it several times, also with newest version of Joplin to no avail. I’ve uninstalled this extension for now.

Thank you very much. It works very well. I’m not sure where the repo is so I might list two problems I’ve met.

  1. The .md is opened with the default editor, e.g., Emacs in my case, instead of vscode. So I have to change it from Emacs to score, which is not that convenient.
  2. Cmd+Space (macOS) is mostly set for spotlight, some other default keybinding might be better?

Testing under macOS Mojave 10.14.6

It looks very cool, thanks for the effort!

If you don’t mind me asking: From a functional perspective, how is your vscode + Joplin solution different from just using vscode + directories + git sync? I’m really not trying to make a case in favor or against something, but to me, it always felt that Joplin brings navigation, synchronization, and editing in a nice package to the table. Once you are ‘outsourcing’ navigation and editing to vscode and sync to git, what usecase remains for Joplin?

In fact, I am satisfied with joplin’s synchronization and search functions, but in contrast, it does not support editing and shortcut keys-obviously, joplin knows it, so it allows editing in an external editor, I just do Some work has been done to make editing easier, that’s all. In addition, I also use vscode + git sync. There are some troublesome problems in synchronization. There is not much criticism in search and editing.

sgugler via Joplin Forum <cozic@discoursemail.com>

The first point I seem to be powerless, because I need to use joplin’s api to open notes (the file does not exist in the local file system before opening, it is saved in the database), unless joplin’s api needs to support only sharing and not open the default The editor also returns the location of the md file. The second point is that I don’t quite understand what you’re talking about. If joplin’s shortcuts conflict with some Mac OS’s shortcuts, you need to issue an issue like joplin’s official

Also I am not sure this is the best way, this is just an experiment, a comparison of joplin integrated into vscode and joplin/vscode + git, and even I want to know whether joplin + vscode is really better than notion (it has recently optimized search The algorithm makes it faster, and the original basic paid plan is free, but the editing function is still a custom format-it seems to support some markdown features)

I’ll test the plugin. Looks very interesting. I caught myself often to use VS keybindings in Joplin when writing markdown (e.g. alt+ Cursor up/down to move lines). :slight_smile:
Thanks for your work!