mirrors/hugo-tufte
1
0
Fork 1
mirror of https://github.com/loikein/hugo-tufte.git synced 2024-12-24 14:29:44 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
slashformotion 2021-07-30 21:19:04 +02:00
parent 07a755cafb
commit 66a3d218df
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -5,7 +5,7 @@ Hugo-Tufte is a minimalist blog-like theme for the
[static site generator Hugo](https://gohugo.io) that [static site generator Hugo](https://gohugo.io) that
attempts to be a faithful implementation of the attempts to be a faithful implementation of the
[Tufte-css](https://github.com/edwardtufte/tufte-css) project. [Tufte-css](https://github.com/edwardtufte/tufte-css) project.
It supports mathematical typesetting via [katex](https://katex.org/). It supports mathematical typesetting via [katex](https://katex.org/) or [MathJax](https://www.mathjax.org).
By utilizing copious partial templates the theme is largely customizable. By utilizing copious partial templates the theme is largely customizable.
## State of Project ## State of Project
@ -18,10 +18,9 @@ This is a fork of the original [hugo-tufte](https://github.com/shawnohare/hugo-t
### Math ### Math
[katex](https://katex.org/) renders LaTeX written inside of markdown files. LaTeX can be [Katex](https://katex.org/) or [MathJax](https://www.mathjax.org) renders LaTeX written inside of markdown files. LaTeX can be written more or less as normal. Some examples:
written more or less as normal. Some examples:
- This `$ \frac{1}{2} $` will be rendered inline. - This `$\frac{1}{2}$` will be rendered inline.
- A simple displayed equation: `$$f(x, y) := e^{x^2 - y^2}.$$` - A simple displayed equation: `$$f(x, y) := e^{x^2 - y^2}.$$`
There currently seems to be some weirdness with other environments, There currently seems to be some weirdness with other environments,
@ -38,7 +37,7 @@ an involution, hence for any $x$, $y$ in $G$ we have:
&=xyxy \implies \\ &=xyxy \implies \\
y^{-1} &= xyx \implies \\ y^{-1} &= xyx \implies \\
y^{-1}x^{-1} &= xy, y^{-1}x^{-1} &= xy,
\end{aligned*} \end{aligned}
</p> </p>
establishing that $G$ is abelian. establishing that $G$ is abelian.
@ -52,6 +51,8 @@ The site specific parameters that this theme recognizes are:
- `showPoweredBy` boolean: if true, display a shoutout to Hugo and this theme. - `showPoweredBy` boolean: if true, display a shoutout to Hugo and this theme.
- `copyrightHolder` string: Inserts the value in the default copyright notice. - `copyrightHolder` string: Inserts the value in the default copyright notice.
- `copyright` string: Custom copyright notice. - `copyright` string: Custom copyright notice.
- `math` boolean: Site wide kill switch for Latex support
- `katex` boolean: if "katex" is set to true katex will be used to render LaTex, if not MathJax will be used instead
### Page Parameters ### Page Parameters