Skip to content

Commit db4312e

Browse files
committed
📝 Add emojis:
1 parent ff173d0 commit db4312e

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ toc::[]
2424

2525
## {example}
2626

27-
## Installation
27+
## 📝 Installation
2828

2929
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.. )] 😛
3030

@@ -34,9 +34,9 @@ pip3 install --user --upgrade adoc-math
3434
adoc-math-setup # will call `npm i -g mathjax@3` and `npm link`
3535
----
3636

37-
## Overview
37+
## 📝 Overview
3838

39-
### Background
39+
### 🔍 Background
4040

4141
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.
4242

@@ -47,15 +47,15 @@ I think of {adoc} as a markup syntax somewhere between {markdown} and {latex}. I
4747
4848
and many other formats! There is even an {adoctorjs} version (an automated translation of the Ruby code to JavaScript).
4949

50-
### LaTeX
50+
### 🔍 LaTeX
5151
Putting LaTeX equations in other places than a TeX document is not so easy. There are two main libraries for this:
5252

5353
* :mathjax:
5454
** It uses native browser fonts and a lot of Css to replicate {latex} in the browser.
5555
* :katex:
5656
** Similar to {mathjax}, built by Khan Academy.
5757
58-
### STEM
58+
### 🔍 STEM
5959
STEM stands for Science, Technology, Engineering, Mathematics, basicaly {latex}. There are two sections in the {adoc} documentation on STEM:
6060

6161
* {adoc-stem}
@@ -68,7 +68,7 @@ TLDR:
6868
** Some more references:
6969
*** https://github.com/asciidoctor/asciidoctor-mathematical/issues/45
7070
71-
### Architecture
71+
### 🔍 Architecture
7272
7373
That's where `adoc-math` comes in! I decided for:
7474
@@ -78,7 +78,7 @@ I couldn't use {katex} because only {mathjax} has an Svg output (see https://git
7878
7979
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.
8080
81-
### Usage
81+
### 🔍 Usage
8282
8383
[cols="2*"]
8484
|===
@@ -100,7 +100,7 @@ $$
100100
For more examples, see the {example}.
101101
102102
103-
## FAQ
103+
## 📝 FAQ
104104
105105
> Why isn't `adoc-math` written in Ruby?
106106
@@ -134,7 +134,7 @@ This first version is geared towards Pdf output. Happy to add more powerful supp
134134
135135
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.
136136
137-
## Debugging
137+
## 📝 Debugging
138138
139139
> I get a MODULE_NOT_FOUND error.
140140

0 commit comments

Comments
 (0)