Added a quickstart section.

Added a quickstart section for people new to Hugo to quickly get to using this theme.
This commit is contained in:
Andrew Quinn 2021-11-21 12:14:22 +02:00 committed by GitHub
parent b08e62319b
commit 6e7db02fc8
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).
## 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
### Math