This is a Fork of adityatelange/hugo-PaperMod

It has mostly been for my own experimentation, so many things are in a WIP state. I welcome feedback. You can demo it here.

New features

Your best bet is to go to Shortcode Examples | PaperMod-Fork

New Shortcodes

• to embed asciinema
• to include mermaid charts
• for embedding an svg
• for a blog image (WIP)
  • base url for images should be in config.yml as a Param, currently is hard coded for expediency.

Undocumented Features

• minor color alterations
• media print produces a cleaner document
• foldable TOC
• sub sections
• • changed search, currently BROKEN on gh-pages,
  • fix search
  • document
• include shortcode (for embedding other local markdown in to the current document)
  • make less brittle with file not found (use a with)
• concat
  • creates an overview of the current section with ALL content in a single document.
  • update styling with regard to flexbox problems
  • document

Original Readme

Hugo PaperMod | Demo

☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive

Hugo PaperMod is a theme based on hugo-paper. The goal of this project is to add more features and customization to the og theme.

The demo includes a lot of documentation about Installation, Features with a few more stuff. Make sure you visit it, to get an awesome hands-on experience and get to know about the features ...

ExampleSite can be found here: exampleSite. Demo is built up with exampleSite as source.

---

---

Features/Mods 💥

• Uses Hugo's asset generator with pipelining, fingerprinting, bundling and minification by default.
• 3 Modes:
  • Regular Mode.
  • Home-Info Mode.
  • Profile Mode.
• Table of Content Generation (newer implementation).
• Archive of posts.
• Social Icons (home-info and profile-mode)
• Social-Media Share buttons on posts.
• Menu location indicator.
• Multilingual support. (with language selector)
• Taxonomies
• Cover image for each post (with Responsive image support).
• Light/Dark theme (automatic theme switch a/c to browser theme and theme-switch button).
• SEO Friendly.
• Multiple Author support.
• Search Page with Fuse.js
• Other Posts suggestion below a post
• Breadcrumb Navigation
• Code Block Copy buttons
• No webpack, nodejs and other dependencies are required to edit the theme.

Read Wiki For More Details => PaperMod - Features

---

Install/Update 📥

Read Wiki For More Details => PaperMod - Installation

---

Social-Icons/Share-Icons 🖼️

Read Wiki For More Details => PaperMod-Icons

---

FAQs / How To's Guide 🙋

Read Wiki For More Details => PaperMod-FAQs

---

Release Changelog

Release ChangeLog has info about stuff added: Releases

---

Pagespeed Insights (100% ?)

---

Special Thanks 🌟

• Highlight.js
• Fuse.js
• Feather Icons
• Simple Icons
• All Contributors and Supporters