VSCode Markdown Remote

This page is not included in Tangotron's menu.

Markdown with VSCode via remote connection from Windows, Chromebook, Mac, or linux can be used across platforms to create and edit these posts about the Raspberry Pi computer, but a description of VSCode and Markdown does not strongly relate to the RPi topic. A second menu about Markdown editors is a possibility.

Amazingly, I'm not having a problem (yet), so if you are a forum problem-solver, stop reading.

VScode is powerful and flexible but could seem daunting at first. However, the built-in help and command-search features are exceptional. I've installed it (or use it remotely) on everything: Mac, Windows, Chromebook, Linux, and the Raspberry Pi OS.

Some folks don't like Microsoft checking up on how VScode is working on their computer. You can turn that off in VScode Settings. In Settings, search for "telemetry" and uncheck:

  • Telemetry: Enable Crash Reporter
  • Telemetry: Enable Telemetry

Two recent Raspberrypi.org blog articles inspired me to install VScode on a Raspberry Pi model 4 (4GB ram), running Ubuntu on one micro SD card and the Raspberry Pi OS on another card. VScode works equally well with either OS on the Raspberry Pi computer. Here are the blog links:

https://www.raspberrypi.org/blog/visual-studio-code-comes-to-raspberry-pi/

https://www.raspberrypi.org/blog/coding-on-raspberry-pi-remotely-with-visual-studio-code/

I also use RPi (Raspberry Pi) headless (without monitor or keyboard) for early models 3b and 3a, so I installed VSCode on Mac, Windows, and Chromebook, adding the extension "Remote Development" bundle per the "coding remotely" blog link above, then connected to those RPi computers where I continued to edit this article.

The remote connections from Mac and Chromebook automatically supply my local user name which, in my case, is not the same as the RPi user. I edited the newly created SSH configuration file -- easy with VScode Command Palette using shortcut keys Ctl+Shift+P and typing "Remote SSH open" to choose the configuration file, "Users/{username}/.SSH/config". Edit the top line of each referenced connection to look like the following (I use a non-default SSH port number in this generic example, but you may not need the colon with number at end). Here's my local network remote connection example:

Host: myname@mycomputer.local:1313

From Windows, I used the host's ip number rather than the "{mycomputer}.local" name.

I'm especially fond of VScode's remote Markdown editing (with built-in Preview!) from Mac, Chromebook Linux or Window's WSL (Windows Subsystem for Linux) because it works and looks the same among all platforms and OSes (sadly,not iPadOS). There are many more options than Markdown, approximately 40 syntax-checkers with the VScode editor. Python next?

Here's the list:

  • Batch (bat)
  • C ©
  • C#(csharp)
  • C++ (cpp)
  • CSS (css) Clojure (clojure)
  • CoffeeScript (coffeescript)
  • Diff (diff) Docker (dockerfile)
  • F# (fsharp) Git Commit Message (git-commit)
  • Git Rebase Message (git-rebase)
  • Go (go) Groovy (groovy)
  • HLSL (hlsl)
  • HTML (html)
  • Handlebars (handlebars)
  • Ignore (ignore) Ini (ini)
  • JSON (json) JSON with Comments (jsonc)
  • Java (java) JavaScript (javascript)
  • JavaScript React (javascriptreact)
  • Less (less)
  • Log (log)
  • Lua (lua)
  • Makefile (makefile) Markdown (markdown) - Configured Language
  • Objective-C (objective-c) Objective-C++ (objective-cpp)
  • PHP (php)
  • Perl (perl) Perl 6 (perl6) Plain Text (plaintext)
  • PowerShell (powershell)
  • Properties (properties)
  • Pug (jade)
  • Python (python)
  • R ®
  • Razor (razor)
  • Ruby (ruby)
  • Rust (rust)
  • SCSS (scss)
  • SQL (sql)
  • SSH Config (ssh_config) Search Result (search-result)
  • ShaderLab (shaderlab) Shell Script (shellscript)
  • Swift (swift) TypeScript (typescript) TypeScript React (typescriptreact)
  • Visual Basic (vb)
  • XML (xml) XSL (xsl) YAML (yaml)
  • scminput (scminput)

How this was published online:
Simplenote® is a free service hosted by Automattic® which also happens to be the parent company of WordPress®. Fortunately, Simplenote is also based on Markdown, so a quick copy/paste of a this document was especially convenient. The permalink is: https://app.simplenote.com/publish/WSllTf


Report abuse