Merge pull request #43 from AndrewQuinn2020/patch-1

Added a quickstart section.
This commit is contained in:
slashformotion 2021-11-21 13:12:25 +01:00 committed by GitHub
commit 0fa412b280
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -11,6 +11,30 @@ By utilizing copious partial templates the theme is largely customizable.
This is a fork of the original [hugo-tufte](https://github.com/shawnohare/hugo-tufte). This is a fork of the original [hugo-tufte](https://github.com/shawnohare/hugo-tufte).
## Quickstart
### Prerequisite: Hugo Extended
You'll need to install Hugo Extended for this theme to test it locally, since this theme uses SCSS.
- On Windows:
- Using [Chocolatey](https://chocolatey.org/):
```powershell
choco install hugo-extended # remember, you might need admin privs
```
### For a new site
```powershell
# this code is shell-agnostic, and should work in cmd, powershell, bash, zsh....
hugo new site <your-site-name> # create your new site with hugo in your pwd
cd <your-site-name>\themes\ # cd into the themes directory
git clone <this-git-repo> # HTTPS link @ the top of the page if you've never done this before
```
Add `theme = 'hugo-tufte'` to your `config.toml` to let your site know to actually use _this_ theme, specifically.
Then run `hugo server -D` and open up `localhost:1313/` or wherever it says in Firefox.
## Features ## Features
### Math ### Math
@ -24,7 +48,7 @@ There currently seems to be some weirdness with other environments,
such as the `aligned` environment (`align*` is not supported by katex). These environments will render provided such as the `aligned` environment (`align*` is not supported by katex). These environments will render provided
they are wrapped in `<p>` tags and blank lines. The snippet below should they are wrapped in `<p>` tags and blank lines. The snippet below should
render correctly. render correctly.
``` ```latex
Let $G$ be a finite group with exponent $2$. Then every element is Let $G$ be a finite group with exponent $2$. Then every element is
an involution, hence for any $x$, $y$ in $G$ we have: an involution, hence for any $x$, $y$ in $G$ we have: