rod2ik/TikZJax

Introduction

is an open-source project that natively renders TikZ/LaTeX AND tkz-tab/LaTeX for maths variation tables and maths sign tables, directly inside a Custom Standalone HTML Page AND/OR inside usual Documentation websites, notably MkDocs with Material theme. Star this project if you like it 🫶🫶🫶 !

| ⚠️ Documentation Link & Testing Site ⚠️ | | ----------------------------------------------------------------------------------------------------------------------------------------- | | Please refer to this MkDocs Documentation & Demo Site for more thorough documentation and more info: https://rod2ik.github.io/tikzjax | | A MINIMAL MKDOCS TIKZJAX TESTING REPOSITORY: https://github.com/rod2ik/minimal-mkdocs-tikzjax Clone it. Test it locally. |

Example 1:

Example 2:

is originally a fork from the great works 👏👏👏 of:

• kisone/tikzjax by Jim Fowler
• drgrice1/tikzjax by Glenn Rice

Please note that:

• Both previous projects are based on their own web2js and dvi2html projects.
• is based on its own custom forks rod2ik/web2js and rod2ik/dvi2html.

Also note that has, since then, been heavily:

• refactored as an ESM project

• extended, to render both TikZ Figures tkz-tab macros, LaTeX style, for math variation tables / math sign tables:

  • a global configuration file tikzjax.config.js through window.TikzJaxOptions;

  • inside a Custom Standalone HTML Page, using a <script type="text/tikz"> tag syntax:

    • automatic rendering of TikZ Figures (THE historical functionality of kisone/tikzjax)

    • ❗📢❗⚠️ automatic rendering of tkz-tab macros, LaTeX style, for maths variation tables / math sign tables ⚠️❗📢❗

    • Light/Dark Themes via the global customisation file, or direct configuration.

    • the <script> syntax is also natively compatible inside an MkDocs Markdown Page:

      • natively 100% compatible with Material Light/Dark Themes
      • natively 100% compatible with Material Admonitions (collapsible, or not)
      • natively 100% compatible with Material Content Tabs (inside Admonitions, or not)

  • inside MkDocs, with Material (or without it..), using a tikzjax code block syntax, natively:

    • automatic rendering of TikZ Figures (you could already do this, but only via the <script> syntax, with kisone/tikzjax)
    • ❗📢❗⚠️ automatic rendering of tkz-tab macros for maths variation tables / math sign tables ⚠️❗📢❗
    • Compatibility with Material Light/Dark Themes (possibly customizable via the global customisation file)
    • compatibility with Material Admonitions: collapsible or not
    • compatibility with Material Content Tabs

  • Other Documentation Sites:

    • Possibly all functionalities of MkDocs, if your documentation tool uses Python-Markdown.

All these syntaxes also offer:

• a global configuration file tikzjax.config.js through window.TikzJaxOptions
• per-table local overrides through data-* attributes
• native and customizable Light/Dark themes support for Custom Standalone HTML blocks, Material for MkDocs
• browser-side cache through IndexedDB
• Spinner animation
• timeout, worker restart, retry handling
• A customizable fallback error image

License

This project is open-source: