Skip to content

0.0.1

Choose a tag to compare

@github-actions github-actions released this 18 Nov 02:12
· 4 commits to master since this release

Export as Markdown 0.0.1

First release. This plugin runs your local obsidian-export CLI from inside Obsidian, so notes that use reference-style syntax can be shared as a single plain Markdown file instead of a PDF.

Requirements

  • obsidian-export must be installed separately — it is not bundled with the plugin. Download a binary from its releases and add it to PATH, or run cargo install obsidian-export.
  • Confirm it works with obsidian-export --version.
  • Desktop only.

Features

  • Export the current note, a folder, or the entire vault.
  • Available from the command palette, a ribbon icon (exports the active note, or the whole vault when no note is active), and an Export item in the file menu for notes and folders.
  • Choose a destination with Browse… or paste a path; it is created when missing.
  • Preview the exact command that will run, follow live logs, and cancel at any time.
  • When the destination is not empty, review the files expected to be overwritten and confirm first (can be disabled in settings).
  • See the files actually written once the export finishes.
  • The last destination folder is remembered.
  • Interface in English and Simplified Chinese; follows Obsidian's language by default and can be overridden in settings.
  • Settings for the common obsidian-export flags: --no-git, --frontmatter, --hidden, --preserve-mtime, --hard-linebreaks, --no-recursive-embeds, plus extra arguments.

Notes

  • Runs entirely on your machine: no network requests, and no vault contents leave your device.
  • The destination cannot be the vault root. Exporting into the vault shows a warning, because Obsidian will index the exported files and a later full-vault export may pick them up again.
  • The output layout is decided by obsidian-export: folder exports are flattened into the destination, vault exports keep the folder structure.

Install

  1. Download main.js, manifest.json and styles.css from the assets below.
  2. Copy them to <Vault>/.obsidian/plugins/export-as-markdown/.
  3. Enable Export as Markdown in Settings → Community plugins.

Export as Markdown 0.0.1(简体中文)

首个版本。本插件让你直接在 Obsidian 中调用本机安装的 obsidian-export 命令行工具,把使用引用写法的笔记导出为单个普通 Markdown 文件,便于分享(不再需要导出成 PDF)。

前置条件

  • 需自行安装 obsidian-export,插件不包含该工具。可从其 Releases 下载二进制并加入 PATH,或执行 cargo install obsidian-export。
  • 用 obsidian-export --version 确认可用。
  • 仅支持桌面端。

功能

  • 导出当前笔记、指定文件夹或整个仓库。
  • 可通过命令面板、左侧功能区图标(有活动笔记时导出当前笔记,否则导出整个仓库),以及笔记/文件夹右键菜单中的 Export 触发。
  • 通过 浏览… 选择目标目录或直接粘贴路径,目录不存在时自动创建。
  • 实时显示将执行的命令和运行日志,可随时取消。
  • 目标目录不为空时,先列出预计被覆盖的文件并确认(可在设置中关闭)。
  • 导出结束后列出本次实际写入的文件。
  • 记住上次使用的目标目录。
  • 界面支持简体中文和英文,默认跟随 Obsidian 语言,也可在设置中指定。
  • 设置项覆盖 obsidian-export 常用参数:--no-git、--frontmatter、--hidden、--preserve-mtime、--hard-linebreaks、--no-recursive-embeds,并支持额外参数。

说明

  • 全程在本机运行:不发起网络请求,也不会上传任何仓库内容。
  • 目标目录不能是仓库根目录;导出到仓库内部时会给出提示,因为导出结果会被 Obsidian 索引,之后导出整个仓库时可能被再次包含。
  • 导出布局由 obsidian-export 决定:导出文件夹时笔记平铺到目标目录,导出整个仓库时保留目录结构。

安装

  1. 下载下方资产中的 main.js、manifest.json 和 styles.css。
  2. 复制到 <Vault>/.obsidian/plugins/export-as-markdown/。
  3. 在 设置 → 第三方插件 中启用 Export as Markdown。