diff --git a/README.md b/README.md index 9fc46f03..678df9ae 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,16 @@ **A fast, clean, and responsive theme for [Hugo](https://gohugo.io/).** [![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=Hugo&message=v0.146.0%2B&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) -[![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) > 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) | +| 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) |

Mockup image @@ -22,7 +20,9 @@ --- -## Features +## Features 💥 + +`☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive` - **Asset pipeline** -- Hugo's built-in asset generator with fingerprinting, bundling, and minification. - **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). @@ -40,41 +40,27 @@ - **Related post suggestions** - **Zero JS build dependencies** -- No webpack, Node.js, or other tooling required. -For the full list, see the **[Features wiki page](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)**. +| Topic | Description | +| ------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| **[Installation guide](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)** | Detailed installation and update instructions | +| **[Features wiki page](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)** | In-depth explanations of all features | +| **[FAQ wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)** | Common questions and configuration walkthroughs | +| **[Icons wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)** | Documentation for social icons and share icons | +| **[Variables wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/Variables)** | List of all available template variables | +| **[Overiding templates](https://github.com/adityatelange/hugo-PaperMod/wiki/Template_Overrides)** | Guide to customizing templates without forking | +| **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)** | Detailed history of releases | --- -## Installation - -Detailed installation and update instructions are available in the **[Installation guide](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)**. - ---- - -## FAQs and How-To Guides - -Common questions and configuration walkthroughs are covered in the **[FAQ wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)**. - ---- - -## Icons - -Documentation for social icons and share icons can be found in the **[Icons wiki](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)**. - ---- - -## Changelog - -See **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)** for a detailed history of changes. - ---- - -## Performance +## Performance ☄️ PaperMod consistently scores near-perfect results on [Pagespeed Insights](https://pagespeed.web.dev/report?url=https://adityatelange.github.io/hugo-PaperMod/). +image + --- -## Support +## Support 🫶 - Star this repository to show your support. - Share PaperMod with others who might find it useful. @@ -82,7 +68,7 @@ PaperMod consistently scores near-perfect results on [Pagespeed Insights](https: --- -## Acknowledgements +## Special Thanks 🌟 - [Highlight.js](https://github.com/highlightjs/highlight.js) - [Fuse.js](https://github.com/krisk/fuse) @@ -92,6 +78,6 @@ PaperMod consistently scores near-perfect results on [Pagespeed Insights](https: --- -## Stargazers +## Stargazers 📈 [![Stargazers over time](https://starchart.cc/adityatelange/hugo-PaperMod.svg?background=%23ffffff00&axis=%23858585&line=%236b63ff)](https://starchart.cc/adityatelange/hugo-PaperMod)