Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/toryanderson/hugo-icarus.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordigitalcraftsman <digitalcraftsman@users.noreply.github.com>2016-02-25 15:22:10 +0300
committerdigitalcraftsman <digitalcraftsman@users.noreply.github.com>2016-02-25 15:22:10 +0300
commit87d8b91b87f7e85d4a9bef48181579299a3a422f (patch)
tree712fd8f6e19bf71e4aebba8cc404d94165dfe249
parent89b1432868f94a554238c8ff03f4b1042970f14d (diff)
Update docs about formula rendering
Fixes #26.
-rw-r--r--README.md4
-rw-r--r--exampleSite/content/post/introducing-icarus-and-its-features.md8
2 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 90eff00..089fef7 100644
--- a/README.md
+++ b/README.md
@@ -107,7 +107,9 @@ This way you can store them either next to the content file or in the `static` f
## Mathematical equations
-In case you need to display equations you can insert your LaTeX or MathML code and it works out of the box thanks to [MathJax](https://www.mathjax.org).
+Mathematical equations in form of LaTeX or MathML code can be rendered with the support of [MathJax](https://www.mathjax.org). MathML works out of the box. If you're using LaTeX you need to wrap your equation with `$$`.
+
+You can also print formulas inline. In this case wrap the formula only once with `$`.
## Shortcodes
diff --git a/exampleSite/content/post/introducing-icarus-and-its-features.md b/exampleSite/content/post/introducing-icarus-and-its-features.md
index f19a30b..8fdba68 100644
--- a/exampleSite/content/post/introducing-icarus-and-its-features.md
+++ b/exampleSite/content/post/introducing-icarus-and-its-features.md
@@ -107,11 +107,13 @@ This way you can store them either next to the content file or in the `static` f
## Mathematical equations
-In case you need to display equations you can insert your LaTeX or MathML code and it works out of the box thanks to [MathJax](https://www.mathjax.org).
+Mathematical equations in form of LaTeX or MathML code can be rendered with the support of [MathJax](https://www.mathjax.org). MathML works out of the box. If you're using LaTeX you need to wrap your equation with `$$` as shown in the following example:
- \[ z = r \cdot (\sin{\phi} + \cos{\phi} \cdot i) \]
+ $$ z = r \cdot (\sin{\phi} + \cos{\phi} \cdot i) $$
-\[ z = r \cdot (\sin{\phi} + \cos{\phi} \cdot i) \]
+$$ z = r \cdot (\sin{\phi} + \cos{\phi} \cdot i) $$
+
+You can also print formulas inline: $a^2 + b^2 = c^2$. In this case wrap the formula only once with `$`.
## Shortcodes