mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2023-12-21 10:22:58 +01:00
84 lines
3.7 KiB
Markdown
84 lines
3.7 KiB
Markdown
![Build GH-Pages](https://github.com/adityatelange/hugo-PaperMod/workflows/Build%20GH-Pages/badge.svg)
|
|
![GitHub](https://img.shields.io/github/license/adityatelange/hugo-PaperMod)
|
|
[![hugo-papermod](https://img.shields.io/badge/Hugo--Themes-@PaperMod-blue)](https://themes.gohugo.io/hugo-papermod/)
|
|
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=adityatelange_hugo-PaperMod&metric=alert_status)](https://sonarcloud.io/dashboard?id=adityatelange_hugo-PaperMod)
|
|
![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod)
|
|
|
|
# PaperMod | [Demo](https://adityatelange.github.io/hugo-PaperMod/)
|
|
|
|
☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive
|
|
|
|
Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper).
|
|
The goal of this project is add more Features and customization to the og theme.
|
|
|
|
The [demo site](https://adityatelange.github.io/hugo-PaperMod/) includes a lot of documentation about Installation, Features with few more stuff. Make sure you visit it, to get the awesome hands-on experience and get known about the features ...
|
|
|
|
ExampleSite can be found here: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite). Demo is built up with exampleSite as source.
|
|
|
|
---
|
|
|
|
<p align="center">
|
|
<kbd><img width=600px src="https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/posts/papermod/papermod-features/images/homeinfo.webp" alt="HomeInfo" /></kbd>
|
|
<kbd><img width=153px src="https://i.ibb.co/LNgGcrt/mobileview.png" alt="HomeInfo" /></kbd>
|
|
</p>
|
|
|
|
---
|
|
|
|
## Install/Update 📥
|
|
|
|
Read this post For More Details => [hugo-PaperMod - Installation](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-installation/)
|
|
|
|
---
|
|
|
|
## Features/Mods 💥
|
|
|
|
- Uses Hugo's asset generator with pipelining, fingerprinting, bundling and minification by default.
|
|
- 3 Modes:
|
|
- Regular Mode.
|
|
- [Home-Info Mode.](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/#home-info-mode)
|
|
- [Profile Mode.](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/#profile-mode)
|
|
- Table of Content Generation (newer implementation).
|
|
- Archive of posts.
|
|
- Social Icons (home-info and profile-mode)
|
|
- Social-Media Share buttons on post.
|
|
- 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.
|
|
- Muliple Author support.
|
|
- Search Page
|
|
- No webpack, nodejs and other depedencies required to edit the theme.
|
|
|
|
Read this post For More Details => [hugo-PaperMod - Features](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/)
|
|
|
|
Release ChangeLog has info about stuff added: [Releases](https://github.com/adityatelange/hugo-PaperMod/releases)
|
|
|
|
Huge thanks to contributors for making this theme better 🙌
|
|
|
|
---
|
|
|
|
## Social-Icons/Share-Icons 🖼️
|
|
|
|
Read this post For More Details => [Social-Icons](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-icons/)
|
|
|
|
---
|
|
|
|
## FAQs / How To's 🙋
|
|
|
|
Read this post For More Details => [How To's Guide](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-how-to/)
|
|
|
|
---
|
|
|
|
## [LightHouse Report (100% ?)](https://lighthouse-dot-webdotdevsite.appspot.com//lh/html?url=https%3A%2F%2Fadityatelange.github.io%2Fhugo-PaperMod%2F)
|
|
|
|
---
|
|
|
|
## Special Thanks 🌟
|
|
|
|
- [**Highlight.js**](https://github.com/highlightjs/highlight.js)
|
|
- [**Fuse.js**](https://github.com/krisk/fuse)
|
|
- [**Feather Icons**](https://github.com/feathericons/feather)
|
|
- **All Contributors and Supporters**
|