Rusty Typewriter

Netlify Status $License$ $Issues$ $Stars$

A minimalist and elegant Hugo theme styled towards serif fonts and a warm color pallete. Perfect for writers, bloggers, and content creators who appreciate a clean and distraction-free experience.

$preview$

Features

🎨 Clean, minimalist design with a vintage typewriter aesthetic
📱 Fully responsive layout
🔍 Built-in search functionality
📚 Table of contents support
🏷️ Custom taxonomies by default
📝 Rich markdown support with syntax highlighting
📋 Customizable sidebar
🔄 Related posts suggestions
📎 File attachments support

Quick Start

Create a new Hugo site:

hugo new site my-blog
cd my-blog

Add the theme as a git submodule:

git init
git submodule add https://github.com/math-queiroz/rusty-typewriter.git themes/rusty-typewriter

Add the theme to your hugo.toml:

theme = 'rusty-typewriter'

Start the development server:

hugo server

Configuration

The theme offers extensive configuration options through your site’s config.toml file. Here are the main settings:

[params.rtwt]
  sidePane = true
  countPageItems = 7

[params.rtwt.home]
  showBio = true
  showAuthorImg = true
  sidePaneTags = true
  showFeatured = true
  showRecent = true
  hideRecentWhenFeatured = true
  countRecent = 5

[params.rtwt.side.home]
  sidePaneSticky = false
  taxonomies = ['tags']
  countTaxonomy = 5

[params.rtwt.side.single]
  sidePaneSticky = true
  showDetails = true
  showTableOfContents = true
  showAttachments = true
  showRelated = true
  countRelated = 5

Front Matter Options

+++
title = "Your Post Title"
date = "2024-03-28"
tags = ["tag1", "tag2"]
topics = ["topic1"]
my_taxonomies = ["value"]
featured = true
+++

Customization

CSS Customization

You can customize the theme’s appearance by creating a custom CSS file:

Create assets/css/custom.css in your site
Add your custom styles
The theme will automatically include your custom CSS
You may take a look at _root.css for existing theme values and variables

If a css file starts with an undescore (_), it will be bundled with the theme default ones, which may affect caching behavior!

Layout Customization

The theme’s templates can be overridden by creating corresponding files in your site’s layouts directory.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This theme is licensed under the MIT License. See the LICENSE file for more information.