Export as Markdown

by Frank Chen
5
4
3
2
1
Score: 50/100

Description

Reviews

No reviews yet.

Stats

0
stars
6
downloads
0
forks
1
days
2
days
2
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
14
commits

Latest Version

2 days ago

Changelog

Export as Markdown 0.0.3

Fixes the only blocking item from the community directory review of 0.0.2. No functional changes — behaves exactly like 0.0.2.

  • manifest.json: reworded description so it no longer contains the word "Obsidian" (the previous text matched it inside obsidian-export), which the automated manifest check rejects.
  • Version bumped to 0.0.3 so the review can rescan a published release.

Requires a separately installed obsidian-export. Desktop only.


Export as Markdown 0.0.3(简体中文)

修复社区目录对 0.0.2 的审核中唯一的阻断项,功能无变化,行为与 0.0.2 一致。

  • manifest.json:调整 description,不再包含 “Obsidian” 一词(原描述在 obsidian-export 中命中该关键词),此前被清单自动检查判为错误。
  • 版本号升至 0.0.3,以便审核重新扫描已发布的版本。

需自行安装 obsidian-export,仅支持桌面端。

README file from

Github

Export as Markdown

English | 简体中文

Some Obsidian notes use reference-style syntax, and sharing them as Markdown rather than PDF can be useful. To share a note as a single Markdown file, I found obsidian-export. Since it is a command-line tool, this plugin makes it possible to run it from Obsidian without remembering CLI commands.

This plugin uses the locally installed obsidian-export CLI to export Obsidian notes as standard Markdown. The plugin does not include obsidian-export.

Features

  • Export the current note: Use the vault root as the source and --start-at to export only the current note, while still resolving its links and embeds.
  • Export a folder from the vault.
  • Export the entire vault.
  • Browse for or enter a destination directory before each export; it is created if it does not exist.
  • View the command that will run and live logs, and cancel an export at any time.
  • If the destination is not empty, review the files expected to be overwritten and confirm before exporting (can be disabled in settings).
  • After exporting, view the full paths of files written (up to 30 paths are shown).
  • Remember the last destination directory used.
  • The interface is available in English and Simplified Chinese. By default it follows Obsidian's language; you can override it in settings.

Prerequisites

  1. Install obsidian-export (it is not bundled with this plugin):
    • Download a binary from Releases and add it to your PATH; or
    • Run cargo install obsidian-export.
  2. Verify the installation by running obsidian-export --version in a terminal.

Build and install

npm install
npm run build

Copy main.js, manifest.json, and styles.css to <Vault>/.obsidian/plugins/export-as-markdown/, then enable the plugin in Settings → Community plugins.

Usage

The command palette provides these commands (the names are localized):

  • Export current note
  • Export folder…
  • Export entire vault…

The download icon in the ribbon works too: it exports the current note when one is active, or the entire vault otherwise.

In the dialog, enter a destination directory. Browse… opens the system directory picker (where you can create a folder), or you can paste a path directly. Review the command preview, then select Start export.

Settings

  • Language: Interface language. Auto follows Obsidian; English and Simplified Chinese are available. Dialogs and settings update immediately, while command names and the ribbon tooltip update after reloading the plugin.
  • obsidian-export path: Full path to the executable, command name, or a folder containing the executable. Leave blank to use obsidian-export from PATH.
  • Auto-detect: Find obsidian-export on PATH. Test: Run --version to verify it is available.
  • Ignore Git rules (--no-git)
  • Frontmatter strategy (--frontmatter auto|always|never)
  • Include hidden files (--hidden)
  • Preserve modification times (--preserve-mtime)
  • Convert soft line breaks to hard line breaks (--hard-linebreaks)
  • Allow recursive embeds (--no-recursive-embeds)
  • Extra arguments: Parsed using shell-style rules (quotes are supported), for example --only-tags published.
  • Open destination after export
  • Confirm before overwriting: When the destination is not empty, list files expected to be overwritten and ask for confirmation before exporting (enabled by default).

Equivalent CLI example

obsidian-export "C:\Vault" --start-at "C:\Vault\Folder\Note.md" --no-git "C:\ExportedMarkdown"

Notes

  • The plugin only runs obsidian-export locally. It makes no network requests and does not upload vault contents.
  • Permissions: this is a desktop-only plugin (isDesktopOnly: true). It uses the Node.js fs module to read the vault folder and to create, inspect, and write the destination folder, and the child_process module to run the obsidian-export executable you configure. The exact command is shown in the export dialog before an export starts.
  • Files outside the vault: exports are written to the destination directory you pick, which usually lives outside the vault. The plugin reads your vault as the source and writes only to that destination; no other path is read or written.
  • The destination cannot be the vault root. If it is inside the vault, the plugin shows a warning because Obsidian will index the exported files, and a later full-vault export may include them again.
  • The export layout is determined by obsidian-export: files are flattened into the destination when exporting a folder, while the folder structure is preserved when exporting the entire vault.
  • The overwrite confirmation predicts files based on the export scope and hidden-file setting. It does not account for .export-ignore, Git ignore rules, or tag filtering, so the plugin still checks whether the destination is non-empty before export.

License

0BSD.