hugo-PaperMod/README.md

91 lines
4.2 KiB
Markdown
Raw Normal View History

2021-04-10 13:27:18 +01:00
<h1 align=center>Hugo PaperMod | <a href="https://adityatelange.github.io/hugo-PaperMod/" rel="nofollow">Demo</a></h1>
2019-04-01 10:57:38 +01:00
2021-04-10 13:27:18 +01:00
<h4 align=center>☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive</h4>
<br>
2020-08-28 07:19:17 +01:00
2021-04-10 13:27:18 +01:00
> Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper).
2021-08-18 16:09:38 +01:00
> The goal of this project is to add more features and customization to the og theme.
2019-04-01 10:57:38 +01:00
2021-08-18 16:09:38 +01:00
The [demo](https://adityatelange.github.io/hugo-PaperMod/) includes a lot of documentation about Installation, Features with a few more stuff. Make sure you visit it, to get an awesome hands-on experience and get to know about the features ...
2018-05-04 18:41:09 +01:00
2021-04-10 13:27:18 +01:00
**ExampleSite** can be found here: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite). Demo is built up with [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite) as source.
2020-10-03 05:30:59 +01:00
2021-10-22 15:31:02 +01:00
[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=0.83.0&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.83.0)
[![Build GH-Pages](https://github.com/adityatelange/hugo-PaperMod/workflows/Build%20GH-Pages/badge.svg)](https://github.com/adityatelange/hugo-PaperMod/deployments/activity_log?environment=github-pages)
[![GitHub](https://img.shields.io/github/license/adityatelange/hugo-PaperMod)](https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE)
[![hugo-papermod](https://img.shields.io/badge/Hugo--Themes-@PaperMod-blue)](https://themes.gohugo.io/themes/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 src="https://user-images.githubusercontent.com/21258296/114303440-bfc0ae80-9aeb-11eb-8cfa-48a4bb385a6d.png" alt="Mockup image" title="Mockup"/></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)
2021-08-18 16:09:38 +01:00
- Social-Media Share buttons on posts.
- 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.
2021-06-10 14:15:30 +01:00
- Multiple Author support.
- Search Page with Fuse.js
- Other Posts suggestion below a post
2021-08-18 16:09:38 +01:00
- Breadcrumb Navigation
2021-04-10 13:27:18 +01:00
- Code Block Copy buttons
2021-08-18 16:09:38 +01:00
- No webpack, nodejs and other dependencies are 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
---
## [Pagespeed Insights (100% ?)](https://pagespeed.web.dev/report?url=https://adityatelange.github.io/hugo-PaperMod/)
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)
2021-08-18 16:09:38 +01:00
- [**Simple Icons**](https://github.com/simple-icons/simple-icons)
- **All Contributors and Supporters**