hugo-PaperMod/README.md

88 lines
4.2 KiB
Markdown
Raw Normal View History

2020-08-28 07:19:17 +01: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 16:06:26 +01: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 18:24:02 +01:00
![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod)
2020-07-24 18:57:22 +01:00
2020-09-25 08:48:15 +01:00
# hugo-PaperMod | [Demo](https://adityatelange.github.io/hugo-PaperMod/)
2019-04-01 10:57:38 +01:00
2020-08-28 07:19:17 +01:00
☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive
2020-09-25 08:48:15 +01:00
Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper).
2020-08-28 07:19:17 +01:00
2020-09-25 08:48:15 +01:00
The goal of this project is add more Features and customization to the og theme.
2019-04-01 10:57:38 +01:00
2020-09-25 08:48:15 +01: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 18:41:09 +01:00
2020-10-03 05:30:59 +01:00
ExampleSite can be found here: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite). Demo is built up with exampleSite as source.
2020-09-25 08:48:15 +01:00
---
2018-05-04 18:41:09 +01:00
2020-09-25 08:48:15 +01: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 08:48:15 +01:00
</p>
2018-05-04 18:41:09 +01:00
2020-08-23 08:45:57 +01:00
---
2018-01-08 16:28:39 +00:00
2020-08-23 08:45:57 +01:00
## Install
2018-01-08 16:28:39 +00:00
2020-09-25 08:48:15 +01:00
Read this post For More Details => [hugo-PaperMod - Installation](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-installation/)
2019-08-19 22:12:16 +01:00
2020-08-23 08:45:57 +01:00
---
2019-08-19 22:12:16 +01:00
2020-08-23 08:45:57 +01:00
## Features/Mods
2018-01-08 16:28:39 +00:00
2020-09-25 08:48:15 +01: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)
2020-10-19 11:28:50 +01:00
- SEO Friendly
2020-09-25 08:48:15 +01:00
- No webpack, nodejs and other depedencies required to edit the theme :)
2020-09-25 08:48:15 +01:00
Read this post For More Details => [hugo-PaperMod - Features](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/)
2020-09-14 13:47:01 +01:00
2020-09-25 08:48:15 +01:00
Release ChangeLog has info about stuff added: [Releases](https://github.com/adityatelange/hugo-PaperMod/releases)
2020-09-14 13:47:01 +01:00
---
2020-10-04 14:31:55 +01:00
## Social-Icons
2020-09-25 08:48:15 +01:00
Read this post For More Details => [Social-Icons](https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-icons/)
2020-09-13 16:49:29 +01:00
2020-09-14 13:47:01 +01:00
---
2020-09-14 13:45:54 +01:00
2020-09-25 08:48:15 +01:00
## LightHouse Report
2020-09-14 13:45:54 +01:00
2020-09-25 08:48:15 +01: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>
2020-10-04 14:31:55 +01:00
---
2020-10-19 11:28:50 +01:00
### Sponsoring
If you like my work and if you think this project is worth to support it, you can
<a href="https://www.buymeacoffee.com/adityatelange" target="_blank">
<img height=40 width=150 src="https://cdn.buymeacoffee.com/buttons/v2/arial-blue.png" alt="Buy Me A Coffee"/>
</a>
---
2020-10-04 14:31:55 +01:00
## Found a bug?
If you spot any bugs, please use [Issue Tracker](https://github.com/adityatelange/hugo-PaperMod/issues) and/or
create a new [Pull Request](https://github.com/adityatelange/hugo-PaperMod/pulls) to fix the issue.
2020-10-19 11:28:50 +01:00
[![GitHub issues](https://img.shields.io/github/issues-raw/adityatelange/hugo-papermod)](https://github.com/adityatelange/hugo-PaperMod/issues?q=is%3Aopen)
[![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/adityatelange/hugo-PaperMod)](https://github.com/adityatelange/hugo-PaperMod/issues?q=is%3Aissue+is%3Aclosed)
[![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/adityatelange/hugo-papermod)](https://github.com/adityatelange/hugo-PaperMod/pulls?q=is%3Aopen+is%3Apr)
[![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/adityatelange/hugo-papermod)](https://github.com/adityatelange/hugo-PaperMod/pulls?q=is%3Apr+is%3Aclosed)