zola/docs/content/themes/papermod/index.md

2.0 KiB

+++ title = "PaperMod" description = "A fast, clean, responsive theme ported to Zola." template = "theme.html" date = 2024-09-02T05:58:27Z

[extra] created = 2024-09-02T05:58:27Z updated = 2024-09-02T05:58:27Z repository = "https://github.com/cydave/zola-theme-papermod.git" homepage = "https://github.com/cydave/zola-theme-papermod" minimum_version = "0.4.0" license = "MIT" demo = "https://cydave.github.io/zola-theme-papermod/"

[extra.author] name = "cydave" homepage = "https://github.com/cydave" +++

Zola PaperMod

A work in progress port of the hugo-PaperMod theme by @adityatelange to Zola

Due to config changes introduced with Zola 0.19, only Zola 0.19.1 and later are currently supported.

Demo @ https://cydave.github.io/zola-theme-papermod/

Features

  • Blog post archive
  • Blog post RSS feeds
  • Tags
  • Tag-based RSS feeds
  • Optional: Custom taxonomies
  • Light / Dark theme switching (with configurable default preference)
  • Syntax highlighting for code snippets (Zola's built-in syntax highlighting)
  • Custom navigation
  • 3 Modes:
    • Regular Mode
    • Home-Info Mode
    • Profile Mode
  • Code copy buttons
  • Search page
  • SEO Metadata
  • Language switcher (multi-language support)

Installation

  1. Download the Theme
git submodule add https://github.com/cydave/zola-theme-papermod themes/papermod
  1. Add theme = "papermod" to your zola config.toml
  2. Copy over the example content to get started
cp -r themes/papermod/content content

Options

Papermod customizations exist under a designated extra.papermod section. Refer to config.toml for available options.

Contributing

If you would like to help out porting hugo-Papermod to Zola feel free to pick up a feature and start working on it. All help, no matter how small the contribution is highly appreciated.