GitHub

Hugo License: MIT Stars

A LaTeX-inspired Hugo theme for elegant technical writing and academic content

Transform your Hugo site into a beautifully typeset document with the classic aesthetics of LaTeX. Perfect for researchers, mathematicians, and anyone who appreciates excellent typography.

screenshot

Live Demo →

✨ Features

  • 📐 LaTeX-style Typography - Classic, elegant document styling inspired by LaTeX
  • ⚡ Server-Side Math Rendering - KaTeX with zero JavaScript overhead, instant page loads
  • 🌓 Automatic Dark Mode - Respects system preferences with seamless theme switching
  • 📱 Mobile Optimized - Fast and responsive on all devices
  • 🚀 Lightning Fast - No client-side JavaScript required for math rendering
  • 🔍 SEO-Friendly - Built-in OpenGraph and Twitter Card support
  • 📝 Sidenotes Support - Elegant margin notes for supplementary content
  • 📄 Article Abstracts - Automatically displays content before <!--more--> as an academic-style abstract
  • 🎨 Customizable - Easy theming with simple configuration
  • ♿ Accessible - Works perfectly even with JavaScript disabled

🎯 Perfect For

  • Researchers & Academics - Write papers and notes with LaTeX-quality output
  • Technical Bloggers - Share tutorials and documentation with beautiful code and math
  • Mathematics Content - Display complex equations with proper typesetting
  • Science Communicators - Present technical content in an elegant, readable format
  • Anyone - Who appreciates clean, professional typography

🚀 Quick Start

Prerequisites

Try It Out

# Clone the repository
git clone https://github.com/hugotex-dev/HugoTeX
cd HugoTeX/exampleSite
# Start the development server
hugo server -t ../..
# Open http://localhost:1313/ in your browser

📦 Installation

Method 1: Git Submodule (Recommended)

# Add the theme as a submodule to your Hugo site
cd your-hugo-site
git submodule add https://github.com/hugotex-dev/HugoTeX.git themes/HugoTeX
# Update your config
echo 'theme = "HugoTeX"' >> hugo.toml

Method 2: Hugo Modules

# Initialize your site as a Hugo module
hugo mod init github.com/yourusername/yoursite
# Add to your hugo.toml
cat >> hugo.toml << EOF
[module]
  [[module.imports]]
    path = "github.com/hugotex-dev/HugoTeX"
EOF
# Get the theme
hugo mod get

Method 3: Direct Clone

# Clone directly into themes directory
cd your-hugo-site/themes
git clone https://github.com/hugotex-dev/HugoTeX.git

⚙️ Configuration

Basic Setup

Create or update your hugo.toml:

baseURL = "https://example.com/"
title = "My Hugo Site"
theme = "HugoTeX"
languageCode = "en"
DefaultContentLanguage = "en"
enableInlineShortcodes = true
footnoteReturnLinkContents = "^"
[pagination]
  pagerSize = 10
[Params]
  description = "A short site description"
  darkmode = true  # Set to true to enforce dark mode
  # lightmode = true  # Set to true to enforce light mode
  [Params.Favicon]
    ico = "/favicon.ico"
    svg = "/favicon.svg"
    png = "/favicon.png"
[Params.Author]
  name = "Your Name"
  abstract = """
  Your bio goes here. This appears on the homepage.
  """
[taxonomies]
  category = "categories"
  tag = "tags"
  series = "series"
[markup]
  [markup.goldmark]
    [markup.goldmark.renderer]
      unsafe = true
    [markup.goldmark.extensions]
      [markup.goldmark.extensions.passthrough]
        enable = true
        [markup.goldmark.extensions.passthrough.delimiters]
          inline = [['$', '$']]
          block = [['$$', '$$']]
  [markup.highlight]
    style = "paraiso-dark"  # Syntax highlighting style

Theme Options

Dark Mode Control

By default, dark mode automatically activates based on the user's system prefers-color-scheme setting.

  • Set darkmode = true to enforce dark mode
  • Set lightmode = true to enforce light mode
  • Omit both for automatic switching

Favicon Support

Define icon paths once under [Params.Favicon]. Every field is optional; only provided values are rendered. The recommended setup uses /favicon.ico, /favicon.svg, and /favicon.png. ico should point to a multi-size .ico file, at minimum 16, 32, and 48 px, for legacy browser support. png is rendered as both a 180x180 PNG favicon fallback and the Apple touch icon.

[Params.Favicon]
  ico = "/favicon.ico"                     # Legacy multi-size .ico fallback
  svg = "/favicon.svg"                     # SVG icon for modern browsers
  png = "/favicon.png"                     # 180x180 PNG fallback and Apple touch icon

Place these files in the site's static directory: static/favicon.ico, static/favicon.svg, and static/favicon.png. For an SVG with shadows, filters, or transparent padding, render a large PNG first, trim the transparent canvas, then resize and re-center the result:

rsvg-convert -f png -w 2048 -h 2048 -o /tmp/favicon-2048.png static/favicon.svg
convert /tmp/favicon-2048.png -alpha set -trim +repage -resize 180x180 -background none -gravity center -extent 180x180 static/favicon.png
convert /tmp/favicon-2048.png -alpha set -trim +repage -resize 16x16 -background none -gravity center -extent 16x16 /tmp/favicon-16.png
convert /tmp/favicon-2048.png -alpha set -trim +repage -resize 32x32 -background none -gravity center -extent 32x32 /tmp/favicon-32.png
convert /tmp/favicon-2048.png -alpha set -trim +repage -resize 48x48 -background none -gravity center -extent 48x48 /tmp/favicon-48.png
convert /tmp/favicon-16.png /tmp/favicon-32.png /tmp/favicon-48.png static/favicon.ico
rm -f /tmp/favicon-2048.png /tmp/favicon-16.png /tmp/favicon-32.png /tmp/favicon-48.png

Meta Descriptions

HugoTeX renders a <meta name="description"> tag in the document head when description content is available. Page front matter description has the highest priority; otherwise an article summary before <!--more--> is used as the description. On the home page, Params.Author.abstract is used as the description when no explicit page description exists. Finally, Params.description provides a site level fallback for all pages.

[Params]
  description = "A short site description"

Use front matter description when a page needs a precise search or social preview description:

+++
title = "An article"
description = "A concise description of the article."
+++

Canonical URLs

HugoTeX renders a canonical link in the document head for every page. By default it uses Hugo's .Permalink, derived from baseURL and the page URL.

Set relcanonical in page front matter only when the page should declare a different canonical URL, for example when the same content also exists at another permanent address. The value is rendered without conversion, so it must be a full absolute URL with scheme and host; do not use relative paths.

+++
title = "A duplicated page"
relcanonical = "https://example.com/original-page/"
+++

Social Media Integration

Enable rich previews on social platforms:

[Params]
  twittercard = true
  opengraph = true

See Hugo's Internal Templates for advanced configuration.

📐 Math Typesetting

HugoTeX uses KaTeX with server-side rendering for mathematical notation.

Why Server-Side?

  • ⚡ Zero JavaScript overhead - Math renders instantly, no client-side processing
  • 📱 Better mobile performance - Especially on slower devices
  • ♿ Works without JavaScript - Accessible by default
  • 🚀 Faster page loads - No render blocking

Usage

Simply write math expressions in your Markdown:

Inline math: $E = mc^2$ →

Read the original on github.com ↗