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

github.com/funkydan2/hugo-kiera.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel W. Flint <swflint@flintfam.org>2020-06-27 03:05:39 +0300
committerSamuel W. Flint <swflint@flintfam.org>2020-06-27 03:05:39 +0300
commite6e582a3e59e055934c4c0bd8fa149e90c4b7ff1 (patch)
tree6013d33c19e8c6f1a61b115c2c599da52f6e0915
parent7f6469e42eefa860405a9d26d9329ac7475f7da8 (diff)
Add documentation for MathJax feature
-rw-r--r--README.md5
-rw-r--r--exampleSite/config.toml1
2 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 9708ecc..629e36d 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ It was originally developed by [b. avianto](https://github.com/avianto/hugo-kier
- [Images](#images)
- [Code highlight](#code-highlight)
- [Font Awesome icons](#font-awesome-icons)
+ - [Mathematics](#mathematics)
- [Commenting](#static-commenting)
- [Support and Pull Requests](#support-and-pull-requests)
@@ -185,6 +186,10 @@ Using fenced code with Chroma support.
For usage, refer to [Font Awesome](https://fontawesome.com/).
+### Mathematics
+
+Set `Params.mathjax` to true to enable support of mathematics display using [MathJax](https://mathjax.org/). Math should be, by default, surrounded by dollar signs and produced using LaTeX syntax. Options may be overriden using `static/js/mathjax-config.js`.
+
### Static Commenting
[Disqus](https://disqus.com/) comments are loaded on demand, by clicking the <kbd>View Comments</kbd> button. Disqus comments can be automatically loaded and displayed by setting `CommentAutoload = true` in `config.toml`.
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index 2b6396d..62369cd 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -34,6 +34,7 @@ pygmentsCodeFences = true
#utterancesIssueTerm = "pathname"
#homepageLength = 10
#commentAutoload = true #This mean reader don't need click, disqus comment autoload
+ #mathjax = true #Enable display of mathematics using mathjax (LaTeX syntax)
# uncomment to enable the Tags link on the main toolbar
# [[menu.main]]