README.md (5488B)
1 # Hugo PaperMod 2 3 **A fast, clean, and responsive theme for [Hugo](https://gohugo.io/).** 4 5 [](https://themes.gohugo.io/themes/hugo-papermod/) 6 [](https://github.com/gohugoio/hugo/releases/tag/v0.146.0) 7 [](https://discord.gg/ahpmTvhVmp) 8 9 > Based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper/tree/4330c8b12aa48bfdecbcad6ad66145f679a430b3), with additional features and customization options. 10 11 <table> 12 <tbody> 13 <tr> 14 <td>Live Demo</td> 15 <td><a href="https://adityatelange.github.io/hugo-PaperMod/">adityatelange.github.io/hugo-PaperMod</a></td> 16 </tr> 17 <tr> 18 <td>Documentation 📚</td> 19 <td><a href="https://github.com/adityatelange/hugo-PaperMod/wiki">Github Wiki</a></td> 20 </tr> 21 <tr> 22 <td>Example Site Source</td> 23 <td><a href="https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite">exampleSite branch</a></td> 24 </tr> 25 <tr> 26 <td><a href="https://www.star-history.com/adityatelange/hugo-papermod"><img src="https://api.star-history.com/badge?repo=adityatelange/hugo-PaperMod&theme=dark" alt="Star History Rank" /></a></td> 27 <td><a href="https://ko-fi.com/H2H229ZWH"><img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="ko-fi" /></a></td> 28 </tr> 29 </tbody> 30 </table> 31 32 33 <p align="center"> 34 <img src="https://user-images.githubusercontent.com/21258296/114303440-bfc0ae80-9aeb-11eb-8cfa-48a4bb385a6d.png" alt="Mockup image" title="Mockup"/> 35 </p> 36 37 --- 38 39 ## Features 💥 40 41 `☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive` 42 43 - **Asset pipeline** -- Hugo's built-in asset generator with fingerprinting, bundling, and minification. 44 - **Three layout modes** -- [Regular](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#regular-mode-default-mode), [Home-Info](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#home-info-mode), and [Profile](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#profile-mode). 45 - **Light and dark themes** -- Automatic switching based on browser preference, plus a manual toggle. 46 - **Multilingual support** -- Includes a built-in language selector. 47 - **Search** -- Client-side search powered by Fuse.js. 48 - **SEO optimized** -- Open Graph, Twitter Cards, and Schema.org structured data out of the box. 49 - **Cover images** -- Per-post cover images with responsive image support. 50 - **Table of contents** -- Auto-generated from heading structure. 51 - **Multiple authors** -- Native support for multi-author sites. 52 - **Social icons and share buttons** -- Configurable social links and per-post sharing. 53 - **Breadcrumb navigation** 54 - **Post archives and taxonomies** 55 - **Code block copy buttons** -- One-click copying with Chroma syntax highlighting. 56 - **Related post suggestions** 57 - **Zero JS build dependencies** -- No webpack, Node.js, or other tooling required. 58 59 | Topic | Description | 60 | ------------------------------------------------------------------------------------------------- | ----------------------------------------------- | 61 | **[Installation guide](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)** | Detailed installation and update instructions | 62 | **[Features wiki page](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)** | In-depth explanations of all features | 63 | **[FAQ wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)** | Common questions and configuration walkthroughs | 64 | **[Icons wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)** | Documentation for social icons and share icons | 65 | **[Variables wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/Variables)** | List of all available template variables | 66 | **[Overiding templates](https://github.com/adityatelange/hugo-PaperMod/wiki/Template_Overrides)** | Guide to customizing templates without forking | 67 | **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)** | Detailed history of releases | 68 69 --- 70 71 ## Performance ☄️ 72 73 PaperMod consistently scores near-perfect results on [Pagespeed Insights](https://pagespeed.web.dev/report?url=https://adityatelange.github.io/hugo-PaperMod/). 74 75 <img width="481" height="116" alt="image" src="https://github.com/user-attachments/assets/497d831b-d143-4a46-bc11-b1d7f8ef4a83" /> 76 77 --- 78 79 ## Support 🫶 80 81 - Star this repository to show your support. 82 - Share PaperMod with others who might find it useful. 83 - Sponsor the project on [GitHub Sponsors](https://github.com/sponsors/adityatelange) or [Ko-Fi](https://ko-fi.com/adityatelange). 84 85 --- 86 87 ## Special Thanks 🌟 88 89 - [Highlight.js](https://github.com/highlightjs/highlight.js) 90 - [Fuse.js](https://github.com/krisk/fuse) 91 - [Feather Icons](https://github.com/feathericons/feather) 92 - [Simple Icons](https://github.com/simple-icons/simple-icons) 93 - All contributors and supporters 94 95 --- 96 97 ## Stargazers 📈 98 99 [](https://starchart.cc/adityatelange/hugo-PaperMod)