fix: more README link changes for the sr.ht move
fix: CI fix
change: updates readme for fork
Hugo-Tufte is a minimalist blog-like theme for the static site generator Hugo that attempts to be a faithful implementation of the Tufte-css project. The current version supports mathematical typesetting via KaTeX.
You'll need to install Hugo Extended for this theme to test it locally, since this theme uses SCSS.
choco install hugo-extended # remember, you might need admin privs
brew install hugo
hg clone https://hg.sr.ht/~ser/hugo-tufte
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
hugo new site <your-site-name>
cd <your-site-name>/themes/
hg clone https://hg.sr.ht/~ser/hugo-tufte
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.
In this version, I use Yihui Xie's method to support (almost) seamless LaTeX rendering with KaTeX.
For usage and examples, refer to ./exampleSite/content/posts/tufte-features.md .
Downside: LaTeX in post title is no longer supported.
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 supportcodeBlocksDark
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.)sansSubtitle
boolean: If true
, all subtitles (h2
& h3
) will use up-right and sans-serif font. (As seen in Visual Display of Quantitative Information.)centerArticle
boolean: Not implemented yet)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
: stringgitlab
: stringtwitter
: stringlinkedin
: stringpatreon
: stringyoutube
: stringmedium
: stringreddit
: stringstackoverflow
: stringinstagram
: stringmastodon
: stringorcid
: stringgoogle_scholar
: stringPlease see exampleSite/config.yaml
to see the full implementation with exemples.
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.type
string: If set to book
, layout files in ./layouts/book/ will be prioritised.layout
string: If set, layout files with the name of this field's value will be prioritised.This theme provides the following shortcodes in an attempt to completely support all the features present in the Tufte-css project.
For usage and examples, refer to ./exampleSite/content/posts/tufte-features.md .
blockquote
div
epigraph
marginnote
sidenote