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

github.com/dataCobra/hugo-vitae.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordataCobra <datacobra@mailbox.org>2020-03-24 16:29:24 +0300
committerdataCobra <datacobra@mailbox.org>2020-03-24 16:29:24 +0300
commitac7a462905d427af5b25cf4d009bae942391ecff (patch)
treeaab1fbffe1c54a9fad10bc96b334d7d84d4011f0 /README.md
parent5302b6e47a613865ed6652db4f0eb40f8d8083c2 (diff)
Add KaTeX for math typesetting1.0.7
Math typesetting is now built-in and can be used. To avoid that the scripts are being loaded from third parties. The required script and css files are now delivered directly with hugo-vitae.
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 20 insertions, 4 deletions
diff --git a/README.md b/README.md
index b92bb88..1ca3929 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,7 @@ to **Features**
* **(+)** New array front matter notaxonomy
* **(+)** Author/Writer display in post with extra features
* **(+)** New bool front matter nofeed
+* **(+)** KaTeX for math typesetting
* Multilingual support for month names
* Syntax highlighting
* Custom CSS
@@ -76,13 +77,13 @@ For more information about installation read the
### GDPR in mind
-The GDPR has many rules for third-party assets, so if you don't want to think
-about GDPR complaints you can disable every third-party asset that is
+The GDPR has many rules for third party assets, so if you don't want to think
+about GDPR complaints you can disable every third party asset that is
integrated.
-Some websites using webfonts from third-party sites like google. This theme
+Some websites using webfonts from third party sites like google. This theme
brings FontAwesome and Roboto(-Slab) directly with it without having to
-integrate them via third-party sites.
+integrate them via third party sites.
### Setting the month names in another language
@@ -226,6 +227,21 @@ If you want to modify the `index.xml` layout. Copy the Vitae layout from
`hugo-vitae/layouts/index.xml` to your Hugo site root directory into the
folder `layouts/` and change it the way you want.
+### KaTex for math typesetting
+
+Now you are able to use math typesetting. With this new feature, mathematical
+formulas can be setup easy and will displayed.
+
+The files that are necessary to accomplish that are delivered directly with
+the theme and don't need to be loaded from a third party.
+
+You can either add the "math" front matter with the value "yes" to the content
+you want to be able to show formulas or you can enable this feature global
+with the math param in your websites config file.
+
+An example can be found in the folder "exampleSite" or via the
+[demo](https://themes.gohugo.io/theme/hugo-vitae/).
+
## Credits
* [hugo-ink](https://github.com/knadh/hugo-ink) from which Vitae was forked