alois/hugo-PaperMod
1
0
Fork 0
mirror of https://github.com/adityatelange/hugo-PaperMod.git synced 2026-05-21 11:05:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor README.md for clarity and organization; update features section and improve formatting

Browse Source
This commit is contained in:
Aditya Telange
2026-04-11 01:16:14 +05:30
parent d76a7f8e87
commit 893811ac43
1 changed files with 47 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+47 -56
View File
@@ -1,24 +1,20 @@
<h1 align=center>Hugo PaperMod | <a href="https://adityatelange.github.io/hugo-PaperMod/" rel="nofollow">Demo</a></h1> # Hugo PaperMod
<h4 align=center>☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive</h4> **A fast, clean, and responsive theme for [Hugo](https://gohugo.io/).**
<br>
> Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper/tree/4330c8b12aa48bfdecbcad6ad66145f679a430b3).<br>
> The goal of this project is to add more features and customization to the og theme.
**Documentation** can be found here: [**📚 Wiki**](https://github.com/adityatelange/hugo-PaperMod/wiki)
**ExampleSite** can be found here: [**exampleSite**](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite). Demo is built up with [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite) as source.
[![hugo-papermod](https://img.shields.io/badge/Hugo--Themes-@PaperMod-blue)](https://themes.gohugo.io/themes/hugo-papermod/) [![hugo-papermod](https://img.shields.io/badge/Hugo--Themes-@PaperMod-blue)](https://themes.gohugo.io/themes/hugo-papermod/)
[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=>=v0.146.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.146.0) [![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=>=v0.146.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.146.0)
[![Discord](https://img.shields.io/discord/971046860317921340?label=Discord&logo=discord)](https://discord.gg/ahpmTvhVmp) [![Discord](https://img.shields.io/discord/971046860317921340?label=Discord&logo=discord)](https://discord.gg/ahpmTvhVmp)
[![GitHub](https://img.shields.io/github/license/adityatelange/hugo-PaperMod)](https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE) [![GitHub](https://img.shields.io/github/license/adityatelange/hugo-PaperMod)](https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE)
![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod) ![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod)
[![X (formerly Twitter) URL](https://img.shields.io/badge/-Share%20on%20X-gray?style=flat&logo=x)](https://x.com/intent/tweet/?text=Checkout%20Hugo%20PaperMod%20%E2%9C%A8%0AA%20fast,%20clean,%20responsive%20Hugo%20theme.&url=https://github.com/adityatelange/hugo-PaperMod&hashtags=Hugo,PaperMod)
> Based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper/tree/4330c8b12aa48bfdecbcad6ad66145f679a430b3), with additional features and customization options.
--- | Resource | Link |
|----------|------|
| Live Demo | [adityatelange.github.io/hugo-PaperMod](https://adityatelange.github.io/hugo-PaperMod/) |
| Documentation | [Wiki](https://github.com/adityatelange/hugo-PaperMod/wiki) |
| Example Site Source | [exampleSite branch](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite) |
<p align="center"> <p align="center">
<kbd><img src="https://user-images.githubusercontent.com/21258296/114303440-bfc0ae80-9aeb-11eb-8cfa-48a4bb385a6d.png" alt="Mockup image" title="Mockup"/></kbd> <kbd><img src="https://user-images.githubusercontent.com/21258296/114303440-bfc0ae80-9aeb-11eb-8cfa-48a4bb385a6d.png" alt="Mockup image" title="Mockup"/></kbd>
@@ -26,81 +22,76 @@
--- ---
## Features/Mods 💥 ## Features
- Uses Hugo's asset generator with pipelining, fingerprinting, bundling and minification by default. - **Asset pipeline** -- Hugo's built-in asset generator with fingerprinting, bundling, and minification.
- 3 Modes: - **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).
- [Regular Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#regular-mode-default-mode) - **Light and dark themes** -- Automatic switching based on browser preference, plus a manual toggle.
- [Home-Info Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#home-info-mode) - **Multilingual support** -- Includes a built-in language selector.
- [Profile Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#profile-mode) - **Search** -- Client-side search powered by Fuse.js.
- Table of Content Generation (newer implementation). - **SEO optimized** -- Open Graph, Twitter Cards, and Schema.org structured data out of the box.
- Archive of posts. - **Cover images** -- Per-post cover images with responsive image support.
- Social Icons (home-info and profile-mode). - **Table of contents** -- Auto-generated from heading structure.
- Social-Media Share buttons on posts. - **Multiple authors** -- Native support for multi-author sites.
- Menu location indicator. - **Social icons and share buttons** -- Configurable social links and per-post sharing.
- Multilingual support. (with language selector). - **Breadcrumb navigation**
- Taxonomies. - **Post archives and taxonomies**
- Cover image for each post (with Responsive image support). - **Code block copy buttons** -- One-click copying with Chroma syntax highlighting.
- Light/Dark theme (automatic theme switch a/c to browser theme and theme-switch button). - **Related post suggestions**
- SEO Friendly. - **Zero JS build dependencies** -- No webpack, Node.js, or other tooling required.
- Multiple Author support.
- Search Page with Fuse.js
- Other Posts suggestion below a post
- Breadcrumb Navigation.
- Code Block Copy buttons.
- Hugo's Chroma syntax highlighter.
- No webpack, nodejs and other dependencies are required to edit the theme.
Read Wiki For More Details => **[PaperMod - Features](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)** For the full list, see the **[Features wiki page](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)**.
--- ---
## Install/Update 📥 ## Installation
Read Wiki For More Details => **[PaperMod - Installation](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)** Detailed installation and update instructions are available in the **[Installation guide](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)**.
--- ---
## FAQs / How To's Guide 🙋 ## FAQs and How-To Guides
Read Wiki For More Details => **[PaperMod-FAQs](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)** Common questions and configuration walkthroughs are covered in the **[FAQ wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)**.
--- ---
## Social-Icons/Share-Icons 🖼️ ## Icons
Read Wiki For More Details => **[PaperMod-Icons](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)** Documentation for social icons and share icons can be found in the **[Icons wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)**.
--- ---
## Release Changelog 📃 ## Changelog
Release ChangeLog has info about stuff added: **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)** See **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)** for a detailed history of changes.
--- ---
## [Pagespeed Insights (100% ?)](https://pagespeed.web.dev/report?url=https://adityatelange.github.io/hugo-PaperMod/) 👀 ## Performance
PaperMod consistently scores near-perfect results on [Pagespeed Insights](https://pagespeed.web.dev/report?url=https://adityatelange.github.io/hugo-PaperMod/).
--- ---
## Support 🫶 ## Support
- Star 🌟 this repository. - Star this repository to show your support.
- Help spread the word about PaperMod by sharing it on social media and recommending it to your friends. 🗣️ - Share PaperMod with others who might find it useful.
- You can also sponsor 🏅 on [Github Sponsors](https://github.com/sponsors/adityatelange) / [Ko-Fi](https://ko-fi.com/adityatelange). - Sponsor the project on [GitHub Sponsors](https://github.com/sponsors/adityatelange) or [Ko-Fi](https://ko-fi.com/adityatelange).
--- ---
## Special Thanks 🌟 ## Acknowledgements
- [**Highlight.js**](https://github.com/highlightjs/highlight.js) - [Highlight.js](https://github.com/highlightjs/highlight.js)
- [**Fuse.js**](https://github.com/krisk/fuse) - [Fuse.js](https://github.com/krisk/fuse)
- [**Feather Icons**](https://github.com/feathericons/feather) - [Feather Icons](https://github.com/feathericons/feather)
- [**Simple Icons**](https://github.com/simple-icons/simple-icons) - [Simple Icons](https://github.com/simple-icons/simple-icons)
- **All Contributors and Supporters** - All contributors and supporters
--- ---
## Stargazers over time 📈 ## Stargazers
[![Stargazers over time](https://starchart.cc/adityatelange/hugo-PaperMod.svg?background=%23ffffff00&axis=%23858585&line=%236b63ff)](https://starchart.cc/adityatelange/hugo-PaperMod) [![Stargazers over time](https://starchart.cc/adityatelange/hugo-PaperMod.svg?background=%23ffffff00&axis=%23858585&line=%236b63ff)](https://starchart.cc/adityatelange/hugo-PaperMod)