You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ toc::[]
24
24
25
25
##{example}
26
26
27
-
## Installation
27
+
##📝 Installation
28
28
29
29
adoc-math has zero depependencies! So it's fine to install it globallyfootnote:[Theoretically, the only time this could cause issues is if you have another package which has the name adoc-math (it obviously has to have a different PyPI name, because adoc-math is already taken 😛. But this is not very likely.. )] 😛
adoc-math-setup # will call `npm i -g mathjax@3` and `npm link`
35
35
----
36
36
37
-
## Overview
37
+
##📝 Overview
38
38
39
-
### Background
39
+
###🔍 Background
40
40
41
41
I think of {adoc} as a markup syntax somewhere between {markdown} and {latex}. It originated with a https://github.com/asciidoc-py/asciidoc-py[Python implementation], but afaik that isn't actively developed, and the reference implementation is {adoctor} in Ruby.
42
42
@@ -47,15 +47,15 @@ I think of {adoc} as a markup syntax somewhere between {markdown} and {latex}. I
47
47
48
48
and many other formats! There is even an {adoctorjs} version (an automated translation of the Ruby code to JavaScript).
49
49
50
-
### LaTeX
50
+
###🔍 LaTeX
51
51
Putting LaTeX equations in other places than a TeX document is not so easy. There are two main libraries for this:
52
52
53
53
* :mathjax:
54
54
** It uses native browser fonts and a lot of Css to replicate {latex} in the browser.
55
55
* :katex:
56
56
** Similar to {mathjax}, built by Khan Academy.
57
57
58
-
### STEM
58
+
###🔍 STEM
59
59
STEM stands for Science, Technology, Engineering, Mathematics, basicaly {latex}. There are two sections in the {adoc} documentation on STEM:
@@ -78,7 +78,7 @@ I couldn't use {katex} because only {mathjax} has an Svg output (see https://git
78
78
79
79
Unfortunately, {mathjax} 3 doesn't come with a Node CLI package like https://github.com/mathjax/mathjax-node-cli/[MathJax 2]. So I implemented xref:./adoc_math/d_mathjax_wrapper.js[a wrapper] over the library.
80
80
81
-
### Usage
81
+
### 🔍 Usage
82
82
83
83
[cols="2*"]
84
84
|===
@@ -100,7 +100,7 @@ $$
100
100
For more examples, see the {example}.
101
101
102
102
103
-
## FAQ
103
+
## 📝 FAQ
104
104
105
105
> Why isn't `adoc-math` written in Ruby?
106
106
@@ -134,7 +134,7 @@ This first version is geared towards Pdf output. Happy to add more powerful supp
134
134
135
135
The created svgs have a property called `stroke-width` that can adjust this. Unfortunately, it is currently set to 0, so it is not possible to make it thinner. In theory it should be possible to make it *thicker* by increasing that value. xref:./adoc_math/e_svg_transforming.py[svg_transforming.py] would be the place for that; or create an issue and I'll add it.
0 commit comments