mirror of
https://github.com/youfoundjk/TeXcore.git
synced 2026-07-22 07:33:31 +00:00
No description
- Redesigned the settings tab to support structured categories (General, PDF Export, TikZJax, Custom Notes, and What's New) - Implemented a search-based filter in settings that dynamically hides/shows items and highlights matching terms - Added i18n support with `en.json` and a type-safe `t()` utility to handle localized sentence-case labels - Integrated a startup check and "What's New" modal to display the latest updates on first launch or version updates - Declared global `activeDocument` and `activeWindow` properties on the Window interface to ensure strict TypeScript type-safety - Fixed all ESLint issues including deprecated `display()` calls, manual HTML headings, sentence case warnings, and unused variables - Added documentation links support and a feedback footer at the bottom of the settings tab |
||
|---|---|---|
| .github | ||
| __mocks__ | ||
| docs | ||
| src | ||
| test_helpers | ||
| .editorconfig | ||
| .gitignore | ||
| .npmrc | ||
| .prettierignore | ||
| .prettierrc.json | ||
| CONTRIBUTING.md | ||
| esbuild.config.mjs | ||
| eslint.config.mjs | ||
| eslint.css.config.mjs | ||
| jest.config.js | ||
| LICENSE | ||
| manifest.json | ||
| mkdocs.yml | ||
| package-lock.json | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| requirements.txt | ||
| tsconfig.eslint.json | ||
| tsconfig.json | ||
| version-bump.mjs | ||
| versions.json | ||
ObsiTeXcore for Obsidian
A minimalistic Obsidian.md plugin for automatic equation numbering and referencing.
Key Differences from Original
This fork has been redesigned with a focus on simplicity and performance:
- Single-note focus — Only parses the current active note, no vault-wide scans
- Equation-only — No theorem/proof support, just equation referencing
- Custom ID system — Uses
% id: eq-xxxLaTeX comments instead of Obsidian's block references - Zero dependencies — Quick Preview and Math Links functionality built-in
Features
🔢 Automatic Equation Numbering
Add a unique ID to any display math block:
$$
E = mc^2
% id: eq-einstein
$$
Reference it with [[#^eq-einstein]] and the equation is automatically numbered with \tag{1}.
Numbering styles: arabic (1, 2, 3), alph (a, b, c), Alph (A, B, C), roman (i, ii, iii), Roman (I, II, III)
🔗 Smart Referencing
- Type
\eqrefto trigger autocomplete with all equations in the note - Fuzzy or simple search to find equations quickly
- Rendered math preview in suggestions
- Hover over links to see equation popups
📄 PDF Export
Full-featured PDF export with:
- Live preview modal
- Page size, margins, orientation settings
- Custom headers and footers
- CSS snippet support
- Batch folder export
- Table of contents generation
✂️ LaTeX Snippets
Create reusable LaTeX code snippets:
- Accessible via command palette
- Each snippet becomes its own command
- Assign hotkeys to frequently used snippets
📦 Callout Support
Math blocks work inside Obsidian callouts with automatic indentation handling:
> [!theorem]
> $$
> x^2 + y^2 = z^2
> % id: eq-pythagoras
> $$
Use the "Fix callout equations" command to repair broken indentation.
Installation
From Community Plugins
- Open Obsidian Settings → Community plugins
- Click Browse and search for "ObsiTeXcore"
- Click Install, then Enable
Manual Installation
- Download
main.js,manifest.json, andstyles.cssfrom the latest release - Create folder:
<vault>/.obsidian/plugins/obsitexcore/ - Copy the files into this folder
- Restart Obsidian and enable the plugin
Quick Start
- Write a display math block with
$$...$$ - Add
% id: eq-yournameon a new line before the closing$$ - Type
\eqrefanywhere to search and insert a reference - The equation is numbered and the link displays as
(1)
Commands
| Command | Description |
|---|---|
| Insert display math | Insert $$...$$ block template |
| Search equations in active note | Open equation search modal |
| Fix callout equations in active note | Repair callout indentation |
| Export current file to PDF | Open PDF export dialog |
| Insert LaTeX Snippet | Insert a saved snippet |
Configuration
See the Settings Reference for all configuration options.
License
MIT License - see LICENSE for details.