hugo-PaperMod/README.md

88 lines
3.7 KiB
Markdown
Raw Normal View History

2020-12-15 18:31:44 +00:00
# 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).
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.
![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)
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://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/posts/papermod/papermod-features/images/homeinfo.jpg" 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
2021-01-08 18:05:00 +00:00
## Features/Mods 💥
2018-01-08 16:28:39 +00:00
- Uses Hugo's asset generator with pipelining, fingerprinting, bundling and minification by default.
- 3 Modes:
- [Regular Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#regular-mode-default-mode)
- [Home-Info Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#home-info-mode)
- [Profile Mode.](https://github.com/adityatelange/hugo-PaperMod/wiki/Features#profile-mode)
- Table of Content Generation (newer implementation).
- Archive of posts.
2020-11-24 17:46:17 +00:00
- Social Icons (home-info and profile-mode)
- Social-Media Share buttons on post.
- Menu location indicator.
2020-11-24 17:46:17 +00:00
- Multilingual support. (with language selector)
- Taxonomies
- Cover image for each post (with Responsive image support).
2020-11-24 17:46:17 +00:00
- Light/Dark theme (automatic theme switch a/c to browser theme and theme-switch button).
- SEO Friendly.
- Muliple Author support.
- Search Page with Fuse.js
- Other Posts suggestion below a post
- BreadCrumb Navigation
2020-12-15 18:31:44 +00:00
- No webpack, nodejs and other depedencies required to edit the theme.
Read Wiki For More Details => **[PaperMod - Features](https://github.com/adityatelange/hugo-PaperMod/wiki/Features)**
---
2020-09-14 13:47:01 +01:00
## Install/Update 📥
2020-09-14 13:47:01 +01:00
Read Wiki For More Details => **[PaperMod - Installation](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)**
2020-11-24 17:46:17 +00:00
2020-09-14 13:47:01 +01:00
---
2020-12-15 18:31:44 +00:00
## Social-Icons/Share-Icons 🖼️
Read Wiki For More Details => **[PaperMod-Icons](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)**
---
## FAQs / How To's Guide 🙋
Read Wiki For More Details => **[PaperMod-FAQs](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)**
2020-09-13 16:49:29 +01:00
2020-09-14 13:47:01 +01:00
---
2020-09-14 13:45:54 +01:00
## Release Changelog
2020-10-28 17:11:42 +00:00
Release ChangeLog has info about stuff added: **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)**
2020-10-28 17:11:42 +00:00
---
2020-11-24 17:46:17 +00:00
## [LightHouse Report (100% ?)](https://lighthouse-dot-webdotdevsite.appspot.com//lh/html?url=https%3A%2F%2Fadityatelange.github.io%2Fhugo-PaperMod%2F)
2020-10-19 11:28:50 +01:00
---
2020-12-15 18:31:44 +00:00
## 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**