mirrors/hugo-tufte
1
0
Fork 1
mirror of https://github.com/loikein/hugo-tufte.git synced 2024-11-15 04:46:58 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
hugo-tufte/README.md
Shawn O'Hare b3a2e36507 Initial commit.
2015-12-29 18:35:20 -08:00

1.6 KiB
Raw Blame History

Tufte Hugo Theme

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. It supports mathematical typesetting via MathJax. By utilizing copious partial templates the theme is largely customizable.

Site Parameters

The site specific parameters that this theme :wrecognizes are:

  • subtitle string: This is 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.

Page Parameters

  • hideDate boolean: if true, do not display a page date. When meta is set to true, hideDate takes greater precedence.
  • hideReadTime boolean: if true, do not display the page's reading time estimate. When meta is set to true, hideReadTime takes greater precedence.
  • math boolean: if true, try to render the page's LaTeX code using MatheJax. The theme follows the conventions in [Hugo's MathJax tutorial].
  • meta boolean: if true, display page meta-data author, date, categories provided these page parameters exist and are not overridden. Content in the /post directory, (i.e., pages of type "post") ignore this parameter.
  • toc boolean: if true, display the table of contents for the page.

Templates

TODO

  • Describe the role of each template file, as commenting within the files themselves seems to break the templates.