/ObsidianShell

Associate Markdown files with Obsidian

Primary LanguageC#MIT LicenseMIT

ObsidianShell

Languages: English, 简体中文

Features

  • Associate Markdown files with Obsidian

    In addition to making it easy to open notes, associating files helps integrate Obsidian into your workflows. For example, you can use a launcher to quickly open notes.

    For Chinese users:
    配合支持拼音搜索的启动器，还可以间接实现通过拼音搜索笔记文件，比如：

  • VaultRecent/Recent mode

    • Open standalone Markdown files in Obsidian, i.e., use Obsidian as a Markdown editor.
    • Enable the global vault pattern, which means that you can share one config with your notes at different locations.

  • Open Markdown files in Obsidian through command line

Installation

Releases

Config file location: %LOCALAPPDATA%\Chaoses Ib\ObsidianShell\Settings.json

Set as the default program for Markdown files

  1. Right-click on a .md file
  2. Select Open with → Choose another app → ObsidianShell.CLI
  3. Check Always use this app to open .md files
  4. Click OK

CLI

A command line interface program for opening Markdown files in Obsidian.

It supports three opening modes:

  • VaultFallback (default)

    If the Markdown file you want to open is in a vault, open the vault, otherwise open the file using the fallback Markdown editor.

    Markdown editors:

    • Notepad (default)

    • Visual Studio Code

      The use of code is not recommended since it is actually an batch file and will cause some startup delays. Use %LOCALAPPDATA%\Programs\Microsoft VS Code\Code.exe instead.

      OpenFileInWorkspace can be used to open the file in workspace. The settings should be:

      • Editor path: wscript

      • Arguments: "...\OpenFileInWorkspace.vbs" {0}

        ...\OpenFileInWorkspace.vbs should be the absolute path to OpenFileInWorkspace.vbs.

    • Typora (≥ 1.1)

  • VaultRecent

    If the Markdown file you want to open is in a vault, open the vault, otherwise link the file's parent directory to the Recent vault and then open the file.1

  • Recent

    Whether the Markdown file you want to open is in a vault, link its parent directory to the Recent vault and then open it.

Notice: The vault where the Markdown file in (and the Recent vault) must be in the vault list of Obsidian before opening the file, i.e., you must have opened that vault before, otherwise Obsidian will report an error when opening the vault.

ContextMenu

This menu is used to open the corresponding directory in Obsidian, complementing the defect that the CLI cannot be associated with directories.

Footnotes

  1. Open and edit standalone Markdown files - Feature requests - Obsidian Forum ↩