mirror of
https://github.com/loikein/hugo-tufte.git
synced 2024-09-29 01:52:06 +02:00
127 lines
4.6 KiB
Markdown
127 lines
4.6 KiB
Markdown
# Tufte Hugo Theme
|
|
|
|
[](code_of_conduct.md)
|
|
|
|
## History of this project
|
|
|
|
Hugo-Tufte is a minimalist blog-like theme for the
|
|
[static site generator Hugo](https://gohugo.io) that
|
|
attempts to be a faithful implementation of the
|
|
[Tufte-css](https://github.com/edwardtufte/tufte-css) project. The current version supports mathematical typesetting via [KaTeX](https://katex.org/).
|
|
|
|
- The original repo: [shawnohare/hugo-tufte](https://github.com/shawnohare/hugo-tufte)
|
|
- Second repo: [slashformotion/hugo-tufte](https://github.com/slashformotion/hugo-tufte)
|
|
- This ([loikein/hugo-tufte](https://github.com/loikein/hugo-tufte)) is now the _de facto_ third repo although my original intension was only to make a few tweaks.
|
|
|
|
## 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/):
|
|
```shell
|
|
choco install hugo-extended # remember, you might need admin privs
|
|
```
|
|
- On macOS:
|
|
+ Using [Homebrew](https://brew.sh/):
|
|
```shell
|
|
brew install hugo
|
|
```
|
|
|
|
### Check out the example site
|
|
|
|
```shell
|
|
git clone https://github.com/loikein/hugo-tufte.git
|
|
cd hugo-tufte/exampleSite
|
|
hugo server --buildDrafts --disableFastRender
|
|
```
|
|
|
|
Then open `localhost:1313` or wherever it says in browser.
|
|
|
|
The showcase posts are:
|
|
|
|
- `The big old test page`
|
|
- `Tufte CSS`
|
|
|
|
### For a new site
|
|
|
|
```shell
|
|
hugo new site <your-site-name>
|
|
cd <your-site-name>/themes/
|
|
git clone https://github.com/loikein/hugo-tufte.git
|
|
```
|
|
|
|
Add `theme: 'hugo-tufte'` to your `config.yaml` to let your site know to actually use _this_ theme, specifically.
|
|
|
|
Then run `hugo server --buildDrafts --disableFastRender` and open `localhost:1313` or wherever it says in browser.
|
|
|
|
## Features
|
|
|
|
### Math
|
|
|
|
In this version, I use [Yihui Xie's method](https://yihui.org/en/2018/07/latex-math-markdown/) to support (almost) seamless LaTeX rendering with [KaTeX](https://katex.org/).
|
|
|
|
For usage and examples, refer to [./exampleSite/content/posts/tufte-features.md ](https://github.com/loikein/hugo-tufte/blob/main/exampleSite/content/posts/tufte-features.md).
|
|
|
|
Downside: LaTeX in post title is no longer supported.
|
|
|
|
### Site Parameters
|
|
|
|
`params` for this theme are:
|
|
|
|
- `subtitle` string: If set, displayed under the main title.
|
|
- `showPoweredBy` boolean: If `true`, display a shoutout to Hugo and this theme.
|
|
- `copyrightHolder` string: Inserts the value in the default copyright notice.
|
|
- `copyright` string: Custom copyright notice.
|
|
- `math` boolean: Site wide kill switch for Latex support
|
|
- `codeBlocksDark` boolean: If `true`, code blocks will use a dark theme.
|
|
- `marginNoteInd` string: (NEW) Custom indicator for margin notes, with suggestions in comment. (Only displayed on mobile devices or inside `cols` shortcode.)
|
|
|
|
**Socials**
|
|
|
|
_(The followings have not been tested for this repo, use at your own risk.)_
|
|
|
|
You can add links to your social media profile by using thoses parameters:
|
|
|
|
- `github`: string
|
|
- `gitlab`: string
|
|
- `twitter`: string
|
|
- `patreon`: string
|
|
- `youtube`: string
|
|
- `medium`: string
|
|
- `reddit`: string
|
|
- `stackoverflow`: string
|
|
- `instagram`: string
|
|
- `mastodon`: string
|
|
- `orcid`: string
|
|
- `google_scholar`: string
|
|
|
|
Please see [`exampleSite/config.yaml`](https://github.com/loikein/hugo-tufte/blob/main/exampleSite/config.yaml#L47) to see the full implementation with exemples.
|
|
|
|
### Page Parameters
|
|
|
|
- `math` boolean: If `true`, try to render the page's LaTeX code using KaTeX.
|
|
- `meta` boolean: If `true`, display page metadata such as author, date, categories.
|
|
+ `hideDate` boolean: If `true`, do not display a page date in metadata.
|
|
+ `hideReadTime` boolean: if `true`, do not display the page's reading time
|
|
estimate in metadata.
|
|
- `toc` boolean: if true, display the table of contents for the page.
|
|
- Layout parameters: (NEW)
|
|
+ For more information, see [Hugo's Lookup Order | Hugo](https://gohugo.io/templates/lookup-order/).
|
|
+ `type` string: If set to `book`, layout files in [./layouts/book/](https://github.com/loikein/hugo-tufte/tree/main/layouts/book) will be prioritised.
|
|
+ `layout` string: If set, layout files with the name of this field's value will be prioritised.
|
|
|
|
### Shortcodes
|
|
|
|
This theme provides the following shortcodes in an attempt to completely
|
|
support all the features present in the [Tufte-css](https://github.com/edwardtufte/tufte-css) project.
|
|
|
|
For usage and examples, refer to [./exampleSite/content/posts/tufte-features.md ](https://github.com/loikein/hugo-tufte/blob/main/exampleSite/content/posts/tufte-features.md).
|
|
|
|
- `blockquote`
|
|
- `div`
|
|
- `epigraph`
|
|
- `marginnote`
|
|
- `sidenote`
|