@rod2ik/tikzjax 1.0.0 β 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +41 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,48 +2,61 @@
|
|
|
2
2
|
|
|
3
3
|
## Introduction
|
|
4
4
|
|
|
5
|
-
[rod2ik
|
|
5
|
+
[](https://github.com/rod2ik/tikzjax) is a [](https://www.gnu.org/licenses/gpl-3.0) opensource project, that natively renders **TikZ/LaTeX** AND **tkz-tab/LaTeX** for **maths variation tables** and **maths sign tables** , directly inside an HTML page AND/OR inside usual documentation websites, notably **MkDocs** with **Material theme**. Star this project, if you like it π«Άπ«Άπ«Ά !
|
|
6
6
|
|
|
7
7
|
| β οΈ Documentation Link β οΈ |
|
|
8
8
|
|---|
|
|
9
|
-
| Please refer to this **MkDocs
|
|
9
|
+
| Please refer to this **MkDocs Documentation & Demo Site** for more thorough documentation and more info: [https://rod2ik.github.io/tikzjax](https://rod2ik.github.io/tikzjax) |
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Example 1:
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
Example 2:
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
[](https://github.com/rod2ik/tikzjax) is originally a fork from the great works πππ of :
|
|
12
22
|
|
|
13
23
|
* [kisone/tikzjax](https://github.com/kisonecat/tikzjax) by [Jim Fowler](https://github.com/kisonecat)
|
|
14
24
|
* [drgrice1/tikzjax](https://github.com/drgrice1/tikzjax) by [Glenn Rice](https://github.com/drgrice1)
|
|
15
25
|
|
|
16
|
-
|
|
17
|
-
|
|
26
|
+
Please note, that:
|
|
27
|
+
|
|
28
|
+
* Both latter projects are based on their own **web2js** and **dvi2html** projects.
|
|
29
|
+
* [](https://github.com/rod2ik/tikzjax) is based on its own custom forks [rod2ik/web2js](https://github.com/rod2ik/web2js) and [rod2ik/dvi2html](https://github.com/rod2ik/dvi2html).
|
|
18
30
|
|
|
19
|
-
|
|
31
|
+
Also note, that [](https://github.com/rod2ik/tikzjax) has, since then, been massively :
|
|
20
32
|
|
|
21
33
|
* **refactored as an ESM project**
|
|
22
|
-
* **extended**, to render both **TikZ Figures**
|
|
23
|
-
* [NEW] a **global configuration file** `tikzjax.config.js` through `window.TikzJaxOptions`;
|
|
34
|
+
* **extended**, to render both [](https://github.com/rod2ik/tikzjax) **TikZ Figures** [](https://github.com/rod2ik/tikzjax) [](https://github.com/rod2ik/tikzjax) `tkz-tab` macros, **LaTeX** style, for **math variations tables** / **math sign tables** :
|
|
35
|
+
* [](https://github.com/rod2ik/tikzjax) a **global configuration file** `tikzjax.config.js` through `window.TikzJaxOptions`;
|
|
24
36
|
* inside a **custom HTML Bloc**, using a `<script type="text/tikz">` tag syntax:
|
|
25
|
-
* [OLD] automatic rendering of **TikZ** Figures (THE historical functionnality of [kisone/tikzjax](https://github.com/kisonecat/tikzjax))
|
|
26
|
-
* [NEW]
|
|
27
|
-
* [NEW] Light/Dark Themes via the ***global customisation file
|
|
28
|
-
* the `<script>` syntax is natively compatible inside an Mkdocs Markdown Page:
|
|
29
|
-
* [NEW] natively compatible with **Material Light/Dark Themes**
|
|
30
|
-
* [NEW]
|
|
31
|
-
* [NEW]
|
|
32
|
-
* inside **MkDocs**, with **Material** (or without it..), using a
|
|
33
|
-
* [NEW] automatic rendering of **TikZ** Figures
|
|
34
|
-
|
|
35
|
-
* [NEW]
|
|
36
|
-
* [NEW]
|
|
37
|
-
* [NEW] compatibility with **Material
|
|
37
|
+
* [](https://github.com/rod2ik/tikzjax) automatic rendering of **TikZ** Figures (THE historical functionnality of [kisone/tikzjax](https://github.com/kisonecat/tikzjax))
|
|
38
|
+
* [](https://github.com/rod2ik/tikzjax) βπ’β:warning: automatic rendering of `tkz-tab` macros, **LaTeX** style, for **maths variations tables** / **math sign tables** :warning:βπ’β
|
|
39
|
+
* [](https://github.com/rod2ik/tikzjax) Light/Dark Themes via the ***global customisation file***, or direct configuration.
|
|
40
|
+
* the `<script>` syntax is also natively compatible inside an **Mkdocs Markdown** Page:
|
|
41
|
+
* [](https://github.com/rod2ik/tikzjax) natively 100% compatible with **Material Light/Dark Themes**
|
|
42
|
+
* [](https://github.com/rod2ik/tikzjax) natively 100% compatible with **Material Admonitions** (collapsible, or not)
|
|
43
|
+
* [](https://github.com/rod2ik/tikzjax) natively 100$% compatible with **Material Content Tabs** (inside Admonitions, or not)
|
|
44
|
+
* inside **MkDocs**, with **Material** (or without it..), using a **`tikzjax` code bloc** syntax, **natively**:
|
|
45
|
+
* [](https://github.com/rod2ik/tikzjax) automatic rendering of **TikZ** Figures
|
|
46
|
+
(you could already this, but only via the `<script>` syntax, with kisone/tikzjax)
|
|
47
|
+
* [](https://github.com/rod2ik/tikzjax) βπ’β automatic rendering of `tkz-tab` macros for **maths variations tables** / **math sign tables** βπ’β
|
|
48
|
+
* [](https://github.com/rod2ik/tikzjax) Compatibility with **Material Light/Dark Themes** (possibly customizable via the ***global customisation file***)
|
|
49
|
+
* [](https://github.com/rod2ik/tikzjax) compatibility with **Material Admonitions**: collapsable or not
|
|
50
|
+
* [](https://github.com/rod2ik/tikzjax) compatibility with **Material Content Tabs**
|
|
38
51
|
* **Other Documentation Sites**:
|
|
39
52
|
* Possibly all functionnalities of MkDocs, if your documentation tools uses python-markdown.
|
|
40
53
|
|
|
41
54
|
All the latter syntaxes also offer:
|
|
42
55
|
|
|
43
|
-
* [NEW] a **global configuration file** `tikzjax.config.js` through `window.TikzJaxOptions
|
|
44
|
-
* [
|
|
45
|
-
* [NEW] native and customizable **Light/Dark themes** support
|
|
46
|
-
* [
|
|
47
|
-
* [
|
|
48
|
-
* [
|
|
49
|
-
* [NEW] A customizable **fallback error image**
|
|
56
|
+
* [](https://github.com/rod2ik/tikzjax) a **global configuration file** `tikzjax.config.js` through `window.TikzJaxOptions`
|
|
57
|
+
* [](https://github.com/rod2ik/tikzjax) **per-table local overrides** through `data-*` attributes
|
|
58
|
+
* [](https://github.com/rod2ik/tikzjax) native and customizable **Light/Dark themes** support for **Custom HTML blocs**, [](https://github.com/rod2ik/tikzjax) **Material for MkDocs**
|
|
59
|
+
* [](https://github.com/rod2ik/tikzjax) **browser-side cache** through IndexedD
|
|
60
|
+
* [](https://github.com/rod2ik/tikzjax) **Spinner animation**
|
|
61
|
+
* [](https://github.com/rod2ik/tikzjax) timeout, worker restart, retry handling
|
|
62
|
+
* [](https://github.com/rod2ik/tikzjax) A customizable **fallback error image**
|