Skip to content

MaolinSun32/obsidian-pot2obsidian-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pot2Obsidian

An Obsidian plugin that bridges Pot-App (a cross-platform translation tool) with your Obsidian vault. It lets you configure a vocabulary file path, which the companion Pot-App plugin reads to automatically save collected words.

How It Works

This plugin writes a shared config file at ~/.pot2obsidian/config.json every time settings change. The Pot-App Pot2Obsidian plugin reads this file to know where to append vocabulary entries — no manual path configuration needed in Pot-App.

[Obsidian Plugin] → ~/.pot2obsidian/config.json → [Pot-App Plugin] → flashcards.md

Features

  • Configure vocabulary file name and folder path within the vault
  • Automatically writes a shared config file for Pot-App to read
  • One-click button to create the vocabulary file if it doesn't exist
  • Saves words in Obsidian Spaced Repetition flashcard format

Output Format

Each collected word is appended to your vocabulary file in flashcard format:

apple
?
n. 苹果

Installation

From Obsidian Community Plugins (Recommended)

  1. Open Obsidian Settings → Community Plugins
  2. Search for "Pot2Obsidian"
  3. Click Install, then Enable

Manual Installation

  1. Download main.js, manifest.json, and styles.css from the latest release
  2. Create a folder pot2obsidian inside your vault's .obsidian/plugins/ directory
  3. Copy the downloaded files into that folder
  4. Restart Obsidian and enable the plugin under Settings → Community Plugins

Configuration

Open Settings → Pot2Obsidian:

Setting Description Default
Vocabulary file name Name of the markdown file flashcards.md
Folder path Relative path within your vault (leave empty for vault root) (empty)

The current full path and config file location are displayed below the settings for reference.

Setup with Pot-App

  1. Install and configure this Obsidian plugin (set your preferred file name and path)
  2. Install the Pot-App Pot2Obsidian plugin in Pot-App
  3. Translate a word in Pot-App and click the collect button — it will be saved to your Obsidian vault automatically

Requirements

  • Obsidian v0.15.0 or later
  • Desktop only (requires filesystem access)
  • Pot-App with the companion collection plugin

Related Projects

License

GPL-3.0


Pot2Obsidian(中文说明)

Obsidian 插件,用于配置 Pot-App 生词本的保存路径。

功能

  • 设置生词本文件名和路径
  • 自动写入共享配置文件,供 Pot-App 插件读取
  • 一键创建生词本文件

安装

社区插件市场

在 Obsidian 设置 → 第三方插件中搜索 "Pot2Obsidian",安装并启用。

手动安装

  1. Release 下载 main.jsmanifest.jsonstyles.css
  2. .obsidian/plugins/ 下创建 pot2obsidian 文件夹
  3. 将文件复制进去,重启 Obsidian 并启用插件

配置

在插件设置中:

  1. Vocabulary file name:生词本文件名(默认 flashcards.md
  2. Folder path:相对于 Vault 根目录的文件夹路径(可留空)

配套使用

  1. 安装此 Obsidian 插件并配置路径
  2. 安装 Pot-App Pot2Obsidian 插件
  3. 在 Pot-App 中翻译并收藏,生词自动保存到 Obsidian

About

Obsidian plugin to configure vocabulary file path for Pot-App integration

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Packages

 
 
 

Contributors