hugo-PaperMod/README.md

63 lines
2.8 KiB
Markdown
Raw Normal View History

2020-08-28 02:19:17 -04:00
![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)
2020-09-16 11:06:26 -04:00
[![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)
2020-09-21 13:24:02 -04:00
![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod)
2020-07-24 13:57:22 -04:00
2020-09-25 03:48:15 -04:00
# hugo-PaperMod | [Demo](https://adityatelange.github.io/hugo-PaperMod/)
2019-04-01 05:57:38 -04:00
2020-08-28 02:19:17 -04:00
☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive
2020-09-25 03:48:15 -04:00
Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper).
2020-08-28 02:19:17 -04:00
2020-09-25 03:48:15 -04:00
The goal of this project is add more Features and customization to the og theme.
2019-04-01 05:57:38 -04:00
2020-09-25 03:48:15 -04:00
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 ...
2018-05-04 13:41:09 -04:00
2020-09-25 03:48:15 -04:00
---
2018-05-04 13:41:09 -04:00
2020-09-25 03:48:15 -04:00
<p align="center">
<kbd><img width=600px src="https://i.ibb.co/GvspqCX/HomeInfo.png" alt="HomeInfo" /></kbd>
<kbd><img width=153px src="https://i.ibb.co/LNgGcrt/mobileview.png" alt="HomeInfo" /></kbd>
2020-09-25 03:48:15 -04:00
</p>
2018-05-04 13:41:09 -04:00
2020-08-23 03:45:57 -04:00
---
2018-01-08 11:28:39 -05:00
2020-08-23 03:45:57 -04:00
## Install
2018-01-08 11:28:39 -05:00
2020-09-25 03:48:15 -04:00
Read this post For More Details => [hugo-PaperMod - Installation](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-installation/)
2019-08-19 17:12:16 -04:00
2020-08-23 03:45:57 -04:00
---
2019-08-19 17:12:16 -04:00
2020-08-23 03:45:57 -04:00
## Features/Mods
2018-01-08 11:28:39 -05:00
2020-09-25 03:48:15 -04:00
- 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-Media Share buttons on post.
- Menu location indicator.
- Multilingual support.
- Cover image for each post
- Light/Dark theme ( automatic theme switch a/c to browser theme)
- No webpack, nodejs and other depedencies required to edit the theme :)
2020-09-25 03:48:15 -04:00
Read this post For More Details => [hugo-PaperMod - Features](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/)
2020-09-14 08:47:01 -04:00
2020-09-25 03:48:15 -04:00
Release ChangeLog has info about stuff added: [Releases](https://github.com/adityatelange/hugo-PaperMod/releases)
2020-09-14 08:47:01 -04:00
---
2020-09-25 03:48:15 -04:00
### Social-Icons
2020-09-25 03:48:15 -04:00
Read this post For More Details => [Social-Icons](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-icons/)
2020-09-13 11:49:29 -04:00
2020-09-14 08:47:01 -04:00
---
2020-09-14 08:45:54 -04:00
2020-09-25 03:48:15 -04:00
## LightHouse Report
2020-09-14 08:45:54 -04:00
2020-09-25 03:48:15 -04:00
<kbd><a href="https://lighthouse-dot-webdotdevsite.appspot.com//lh/html?url=https%3A%2F%2Fadityatelange.github.io%2Fhugo-PaperMod%2F"><img src="https://i.ibb.co/y6RwCzb/lighthouse.png" alt="LightHouse" /></a></kbd>