README file from
GithubLaTeX Helper | LaTeX 助手
A powerful, convenient, and customizable LaTeX symbol panel for Obsidian to enhance your mathematical and scientific note-taking efficiency.
This plugin provides a feature-rich panel that integrates seamlessly into your Obsidian workspace, helping you find and insert complex LaTeX symbols and snippets with ease.
English
✨ Features
- Comprehensive Symbol Library: A clean, dropdown-based UI with a vast collection of LaTeX symbols across multiple categories (Greek, Operators, Arrows, etc.).
- Fully Customizable: Supports editing the symbol library via JSON in the plugin settings. You can add your own categories, symbols, or modify existing ones to suit your workflow.
- Real-time Search: Instantly find the symbol you need by searching its LaTeX code within the currently selected category.
- Seamless Window Management: Easily switch between a docked sidebar panel and a floating pop-out window using a smart, context-aware button.
- Automatic Language Detection: The interface automatically adapts to English or Chinese based on your Obsidian language settings.
- Smart Editing Workflow:
- Automatically adds a space after inserting a symbol to improve readability and speed.
- Reliably returns the cursor focus to the editor after insertion, ensuring an uninterrupted writing flow.
🚀 How to Use
- Open the Panel:
- Click the Sigma (Σ) icon in the left ribbon.
- Or use the Command Palette (
Ctrl/Cmd + P) and search for "LaTeX Helper: Open LaTeX panel".
- Select Category: Use the dropdown menu at the top of the panel to switch between symbol categories.
- Search: Use the search bar to filter symbols in the current category by their LaTeX code (e.g., type
alphato find\alpha). - Insert: Click any symbol button to insert it directly into your active note.
- Dock/Pop-out: Click the icon next to the search bar to toggle the panel between the sidebar and a floating window.
- Customize: Go to
Settings > LaTeX Panel Helperto edit the symbol JSON or reset to defaults.
🖼️ Screenshot
中文
✨ 功能特性
- 全面的符号库：一个界面整洁、基于下拉菜单的符号面板，包含了多个分类下（希腊字母、运算符、箭头等）的大量常用 LaTeX 符号。
- 完全可自定义：支持在插件设置中通过 JSON 编辑符号库。您可以添加自己的分类、符号，或修改现有内容以适应您的工作流。
- 实时搜索：在当前分类下，通过输入符号的 LaTeX 代码来即时查找您需要的符号。
- 无缝窗口管理：通过一个智能的、能感知上下文的按钮，轻松地在侧边栏停靠模式和独立的浮动窗口模式之间切换。
- 自动语言检测：界面语言会自动根据您的 Obsidian 语言设置适配为中文或英文。
- 智能编辑工作流：
- 插入符号后自动添加空格，提高可读性与输入速度。
- 插入操作后，可靠地将光标焦点返回至编辑器，确保您的写作流程不被打断。
🚀 如何使用
- 打开面板：
- 点击 Obsidian 左侧功能区的 Sigma (Σ) 图标。
- 或者使用 命令面板 (
Ctrl/Cmd + P) 并搜索 "LaTeX Helper: Open LaTeX panel"。
- 切换分类：使用面板顶部的下拉菜单来切换不同的符号分类。
- 搜索符号：使用搜索框，通过输入 LaTeX 代码来筛选当前分类下的符号（例如，输入
alpha来查找\alpha）。 - 插入符号：点击任意符号按钮，即可将其插入到您当前正在编辑的笔记中。
- 弹出/停靠：点击搜索框旁边的图标，可以在侧边栏模式和浮动窗口模式之间切换面板。
- 自定义配置：前往
设置 > LaTeX Panel Helper编辑 JSON 配置或重置为默认值。