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
youfoundjk_TeXcore/README.md

50 lines
3 KiB
Markdown
Raw Permalink Normal View History

refactor: reorganize src into modular structure and increase test coverage
2026-06-04 18:50:07 +00:00
<div align="right">
Updated Naming Convention
2026-06-05 12:50:35 +00:00
<img src="https://img.shields.io/github/downloads/YouFoundJK/TeXcore/total?label=Downloads" alt="Downloads" />
<a href="https://youfoundjk.github.io/TeXcore/"><img src="https://img.shields.io/badge/Version-v_0.0.1-blue" alt="Version" /></a>
refactor: reorganize src into modular structure and increase test coverage
2026-06-04 18:50:07 +00:00
</div>
Updated Naming Convention
2026-06-05 12:50:35 +00:00
# TeXcore for Obsidian
initializing
2025-10-30 19:16:32 +00:00
Refactor documentation and enhance features for TeXcore plugin - Updated PDF export documentation to clarify features and settings. - Improved quick preview functionality with detailed technical architecture. - Enhanced equation search and autocomplete sections for better user guidance. - Streamlined snippets documentation for command usage and text transformations. - Revamped TikZ diagrams section to include graphical editor details and usage instructions. - Revised getting started guide for clearer step-by-step setup instructions. - Added new navigation and configuration options in the documentation structure. - Updated plugin manifest files with improved descriptions for clarity.
2026-06-06 09:08:14 +00:00
A minimalistic, high-performance LaTeX assistant for automatic equation numbering, referencing, and TikZ rendering with basic GUI editing in [Obsidian.md](https://obsidian.md/) to transforms your vault into a rich ecosystem for scientific drafting and study.
fix: cast types to unknown for compatibility in TikzJaxLoader and worker functions
2026-06-06 09:52:36 +00:00
<img src="docs/assets/branding/v0.0.2.gif" alt="Prisma Calendar Preview" width="100%">
initializing
2025-10-30 19:16:32 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
📚 **[Full Documentation & Guides](https://youfoundjk.github.io/TeXcore/)**
initializing
2025-10-30 19:16:32 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
---
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
## Key Features
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
- **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.
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
---
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
## Behind the Scenes: The WebAssembly Engine
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
To render TikZ diagrams without forcing you to install a full local LaTeX distribution, TeXcore runs the compiler directly inside Obsidian using WebAssembly:
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
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.
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
---
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
## License
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
This plugin is licensed under the [MIT License](LICENSE).
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
---
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
## Credits & Sourcing
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
The TikZJax engine and assets are derived from and built upon the incredible work of the following open-source projects:
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
1. **[kisonecat/tikzjax](https://github.com/kisonecat/tikzjax)** by Jim Fowler — The original browser-based TeX-in-Wasm compiler.
2. **[drgrice1/tikzjax](https://github.com/drgrice1/tikzjax)** by Glenn Rice — Added Web Worker support, along with additional TeX library and package compilations.
3. **[artisticat1/obsidian-tikzjax](https://github.com/artisticat1/obsidian-tikzjax)** by `artisticat1` — Inspiration for Obsidian integration wrapper that packaged these components.
Added docs
2026-01-21 19:08:11 +00:00
feat(tikz): transition to on-demand lazy asset loading model - Excluded `tikzjax-assets/` directory from production release configurations in `package.json` to reduce package size from ~11MB to under 1.2MB. - Generated `assets-manifest.ts` containing static list of 210+ LaTeX dependencies to resolve package lists statically. - Implemented dynamic downloader in `loader.ts` using Obsidian `requestUrl` to fetch missing TeX files on-demand from CDN and save them locally. - Integrated `showNotice` notifications to notify users about download initiation, completion, and error states. - Implemented lazy font loading in `renderer.ts` to download `tikzjax.css` dynamically on first render. - Resolved worker typescript type overload matching compiler issue. - Satisfied Obsidian release policies by removing unnecessary console logs and direct `Notice` constructor calls.
2026-06-05 13:23:42 +00:00
*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).*
Reference in a new issue Copy permalink