obsidian-plugin/youfoundjk_TeXcore
1
0
Fork 0
mirror of https://github.com/youfoundjk/TeXcore.git synced 2026-07-22 07:33:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
60 commits 3 branches 2 tags 48 MiB
CSS 89.8%
TypeScript 10%
JavaScript 0.2%
Find a file
JK 4b10591bbc feat(tikz): enhance SVG bounding box calculation and layout adjustments for improved rendering
2026-06-05 18:36:11 +02:00
.github Updated Naming Convention 2026-06-05 14:50:35 +02:00
__mocks__ lin fix I 2026-06-04 21:01:36 +02:00
docs feat(tikz): decouple TikZJax loader and assets for fully offline, worker-based rendering 2026-06-05 15:19:32 +02:00
release-artifacts feat(tikz): transition to on-demand lazy asset loading model 2026-06-05 15:27:19 +02:00
scratch fix(tikz): correct symbol rendering shift, compact layout spacing, and resolve dependencies 2026-06-05 18:17:46 +02:00
src feat(tikz): enhance SVG bounding box calculation and layout adjustments for improved rendering 2026-06-05 18:36:11 +02:00
test_helpers feat(settings): redesign settings tab with categories, search, i18n, and what's new modal 2026-06-05 14:29:35 +02:00
tikzjax-assets feat(tikz): decouple TikZJax loader and assets for fully offline, worker-based rendering 2026-06-05 15:19:32 +02:00
.editorconfig initializing 2026-06-04 20:11:56 +02:00
.gitignore updating the plugin 2026-06-04 20:12:07 +02:00
.npmrc initializing 2026-06-04 20:11:56 +02:00
.prettierignore updating the plugin 2026-06-04 20:12:07 +02:00
.prettierrc.json updating the plugin 2026-06-04 20:12:07 +02:00
CONTRIBUTING.md Updated Naming Convention 2026-06-05 14:50:35 +02:00
esbuild.config.mjs fix(tikz): webassembly initialization 2026-06-05 15:50:54 +02:00
eslint.config.mjs fix(tikz): correct symbol rendering shift, compact layout spacing, and resolve dependencies 2026-06-05 18:17:46 +02:00
eslint.css.config.mjs setting up prod release 2026-06-04 20:26:28 +02:00
jest.config.js refactor: reorganize src into modular structure and increase test coverage 2026-06-04 20:50:07 +02:00
LICENSE refactor: reorganize src into modular structure and increase test coverage 2026-06-04 20:50:07 +02:00
manifest-beta.json feat(tikz): transition to on-demand lazy asset loading model 2026-06-05 15:27:19 +02:00
manifest.json feat(tikz): transition to on-demand lazy asset loading model 2026-06-05 15:27:19 +02:00
mkdocs.yml feat(tikz): decouple TikZJax loader and assets for fully offline, worker-based rendering 2026-06-05 15:19:32 +02:00
package-lock.json refactor: reorganize src into modular structure and increase test coverage 2026-06-04 20:50:07 +02:00
package.json feat(tikz): transition to on-demand lazy asset loading model 2026-06-05 15:27:19 +02:00
pnpm-lock.yaml fix(tikz): correct symbol rendering shift, compact layout spacing, and resolve dependencies 2026-06-05 18:17:46 +02:00
pnpm-workspace.yaml updating the plugin 2026-06-04 20:12:07 +02:00
README.md feat(tikz): transition to on-demand lazy asset loading model 2026-06-05 15:27:19 +02:00
requirements.txt updating the plugin 2026-06-04 20:12:07 +02:00
tsconfig.eslint.json updating the plugin 2026-06-04 20:12:07 +02:00
tsconfig.json feat(settings): redesign settings tab with categories, search, i18n, and what's new modal 2026-06-05 14:29:35 +02:00
version-bump.mjs updating the plugin 2026-06-04 20:12:07 +02:00
versions.json feat: redesign settings UI, add Integrations tab, and support dynamic Zotero cleanup command 2026-06-05 14:43:16 +02:00

README.md

Downloads Version

TeXcore for Obsidian

A minimalistic, high-performance LaTeX assistant for automatic equation numbering, referencing, and on-demand TikZ rendering in Obsidian.md.

📚 Full Documentation & Guides

Key Features

  • Equation Numbering & referencing: Auto-numbers equations with custom IDs and provides search-based fuzzy autocomplete suggestion dropdowns via \eqref.
  • On-Demand TikZ Diagrams: Compiles TikZ code blocks asynchronously in a Web Worker, lazy-downloading and caching assets to remain lightweight and bloat-free.
  • Advanced PDF Export: Highly configurable single-note or batch folder PDF exports featuring customizable headers, footers, page sizes, and style overrides.

Behind the Scenes: The WebAssembly Engine

To render TikZ diagrams without forcing you to install a full local LaTeX distribution, TeXcore runs the compiler directly inside Obsidian using WebAssembly:

  1. TeX in Wasm: The core Pascal source code of TeX is compiled into a WebAssembly binary (tex.wasm) via the web2js compiler.
  2. Background Compilation: Because TeX compilation is CPU-bound, the plugin spawns a background Web Worker to run the Wasm engine. This keeps Obsidian's UI completely smooth and responsive.
  3. On-Demand CDN Fetching: When you first run a TikZ diagram, the plugin downloads the pre-compiled format engine (core.dump.gz) and the font stylesheet (tikzjax.css), caching them locally on your disk.
  4. Lazy Caching: If your diagram includes specific packages (e.g. \usepackage{circuitikz}), the loader resolves the files, downloads them from a CDN, and saves them locally. Subsequent renders of the same packages work fully offline.

License

This plugin is licensed under the MIT License.

Credits & Sourcing

The TikZJax engine and assets are derived from and built upon the incredible work of the following open-source projects:

  1. kisonecat/tikzjax by Jim Fowler — The original browser-based TeX-in-Wasm compiler.
  2. drgrice1/tikzjax by Glenn Rice — Added Web Worker support, along with additional TeX library and package compilations.
  3. artisticat1/obsidian-tikzjax by artisticat1 — Inspiration for Obsidian integration wrapper that packaged these components.

Note: The underlying TeX engine binaries, format dumps, and LaTeX style packages are distributed under their respective open-source licenses (GPL-3.0+ / LPPL v1.3c).