LexiSide

by Kymatio
5
4
3
2
1
Score: 50/100

Description

Obsidian plugin: contextual English vocabulary explanations in a side panel.

Reviews

No reviews yet.

Stats

0
stars
20
downloads
0
forks
3
days
3
days
3
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
5
commits

README file from

Github

LexiSide

LexiSide is an Obsidian plugin for exploring English vocabulary while you read. Select a word or phrase in a note and LexiSide explains it in a side panel: structured meanings, usage examples, nuance, collocations, and the word family, plus a visual word map.

Explanations are generated by an AI model that you configure (DeepSeek by default, a local Ollama server, or any OpenAI-compatible endpoint). LexiSide is desktop only.

Features

  • Explain the current selection — select text in a note, open the LexiSide sidebar, and get a contextual explanation.
  • Structured explanation — part of speech, IPA, definitions, examples, register and nuance notes, collocations, and word family.
  • Word map — a generated mermaid diagram of related words, rendered inline. Uses the Pele mermaid renderer when it is available and falls back to Obsidian's built-in renderer.
  • Vocabulary library — save explanations, browse, edit, and export them. Exports are written to the LexiSide Exports folder in the vault root.
  • Pronunciation — DeepSeek text-to-speech or an offline system voice.
  • Anki sync — push saved words to Anki through AnkiConnect.
  • Local cache — repeat lookups are served from a local explanation cache.

Requirements

  • Obsidian 1.15.0 or newer, on desktop.
  • An API key for DeepSeek, a local Ollama server, or another OpenAI-compatible endpoint.

Installation

Community plugins

Once LexiSide is available in the community plugin browser: Settings → Community plugins → Browse, search for "LexiSide", install, and enable it.

Manual installation

  1. Download main.js, manifest.json, and styles.css from the latest release.
  2. Put them in <vault>/.obsidian/plugins/lexiside/.
  3. Reload Obsidian and enable LexiSide in Settings → Community plugins.

Setup

  1. Open Settings → LexiSide.
  2. Choose a Provider and enter the matching API key and Base URL:
    • DeepSeek: https://api.deepseek.com (default).
    • Ollama: http://127.0.0.1:11434/v1; pick an installed model.
    • Any other OpenAI-compatible endpoint; /chat/completions is appended automatically.
  3. Adjust learner level, explanation depth, temperature, and token limits if you want.
  4. Optionally configure pronunciation and AnkiConnect (default http://127.0.0.1:8765).

Usage

  • Ribbon icon or Open sidebar to show the panel.
  • Explain selection now to analyze the current selection without waiting for the automatic trigger.
  • Save current explanation to vocabulary, Copy current explanation, and Regenerate current explanation act on the active explanation.
  • Open vocabulary library to browse, edit, and export saved words.
  • Anki commands test the connection and sync one word or the whole library.

Commands

Command Description
Open sidebar Reveal the LexiSide panel
Explain selection now Explain the current editor selection
Open vocabulary library Browse and export saved vocabulary
Save current explanation to vocabulary Save the shown explanation
Copy current explanation Copy the shown explanation as Markdown
Regenerate current explanation Re-request the explanation, bypassing the cache
Clear explanation cache Delete cached explanations
Anki: test AnkiConnect connection Check the configured AnkiConnect URL
Anki: sync current word Send the current word to Anki
Anki: sync all saved words Send the whole vocabulary library to Anki

Data and privacy

LexiSide stores settings, the vocabulary library, and the explanation cache in the plugin's own data in your vault. Text you choose to explain is sent to the AI endpoint you configure. No other network requests are made. AnkiConnect and Ollama requests stay on your machine unless you point them elsewhere.

Development

The TypeScript sources live in the repository root; tests are in tests/ and design notes in docs/.

npm install
npm run typecheck   # tsc --noEmit
npm test            # node --test tests/*.test.mjs
npm run build       # typecheck + ESBuild bundle -> main.js
npm run dev         # ESBuild watch mode

npm run build type-checks the sources and bundles main.ts into main.js (CommonJS, obsidian kept external, minify off). The bundle is committed so the repository always matches the release assets.

Releases are produced by .github/workflows/release.yml: pushing a tag equal to manifest.json's version rebuilds the bundle, attests the artifacts with actions/attest-build-provenance, and publishes main.js, manifest.json, and styles.css as release assets.

License

MIT