hugo-PaperMod/README.md

106 lines
4.6 KiB
Markdown
Raw Normal View History

2021-04-10 14:27:18 +02:00
<h1 align=center>Hugo PaperMod | <a href="https://adityatelange.github.io/hugo-PaperMod/" rel="nofollow">Demo</a></h1>
2019-04-01 11:57:38 +02:00
2021-04-10 14:27:18 +02:00
<h4 align=center>☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive</h4>
<br>
2020-08-28 08:19:17 +02:00
2023-12-16 14:58:05 +01:00
> Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper/tree/4330c8b12aa48bfdecbcad6ad66145f679a430b3).<br>
2021-08-18 17:09:38 +02:00
> The goal of this project is to add more features and customization to the og theme.
2019-04-01 11:57:38 +02:00
2023-02-04 13:28:07 +01:00
**Documentation** can be found here: [**📚 Wiki**](https://github.com/adityatelange/hugo-PaperMod/wiki)
2018-05-04 19:41:09 +02:00
2023-02-04 13:28:07 +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 06:30:59 +02:00
2023-02-04 13:28:07 +01:00
[![hugo-papermod](https://img.shields.io/badge/Hugo--Themes-@PaperMod-blue)](https://themes.gohugo.io/themes/hugo-papermod/)
[![Minimum Hugo Version](https://img.shields.io/static/v1?label=min-HUGO-version&message=>=v0.112.4&color=blue&logo=hugo)](https://github.com/gohugoio/hugo/releases/tag/v0.112.4)
2023-04-28 18:08:05 +02:00
[![Discord](https://img.shields.io/discord/971046860317921340?label=Discord&logo=discord)](https://discord.gg/ahpmTvhVmp)
[![GitHub](https://img.shields.io/github/license/adityatelange/hugo-PaperMod)](https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE)
![code-size](https://img.shields.io/github/languages/code-size/adityatelange/hugo-PaperMod)
2023-12-16 14:58:05 +01:00
[![X (formerly Twitter) URL](https://img.shields.io/badge/-Share%20on%20X-gray?style=flat&logo=x)](https://x.com/intent/tweet/?text=Checkout%20Hugo%20PaperMod%20%E2%9C%A8%0AA%20fast,%20clean,%20responsive%20Hugo%20theme.&url=https://github.com/adityatelange/hugo-PaperMod&hashtags=Hugo,PaperMod)
2020-09-25 09:48:15 +02:00
---
2018-05-04 19:41:09 +02:00
2020-09-25 09:48:15 +02: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 09:48:15 +02:00
</p>
2018-05-04 19:41:09 +02:00
2020-08-23 09:45:57 +02:00
---
2018-01-08 17:28:39 +01:00
2021-01-08 19:05:00 +01:00
## Features/Mods 💥
2018-01-08 17:28:39 +01: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 18:46:17 +01:00
- Social Icons (home-info and profile-mode)
2021-08-18 17:09:38 +02:00
- Social-Media Share buttons on posts.
- Menu location indicator.
- Multilingual support (with improved language selector)
2020-11-24 18:46:17 +01:00
- Taxonomies
- Cover image for each post (with Responsive image support).
2020-11-24 18:46:17 +01:00
- Light/Dark theme (automatic theme switch a/c to browser theme and theme-switch button).
- SEO Friendly.
2021-06-10 15:15:30 +02:00
- Multiple Author support.
- Search Page with Fuse.js
- Other Posts suggestion below a post
2021-08-18 17:09:38 +02:00
- Breadcrumb Navigation
2021-04-10 14:27:18 +02:00
- Code Block Copy buttons
2021-08-18 17:09:38 +02: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 14:47:01 +02:00
## Install/Update 📥
2020-09-14 14:47:01 +02:00
Read Wiki For More Details => **[PaperMod - Installation](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)**
2020-11-24 18:46:17 +01:00
2020-09-14 14:47:01 +02:00
---
2023-02-04 13:28:07 +01:00
## FAQs / How To's Guide 🙋
2023-02-04 13:28:07 +01:00
Read Wiki For More Details => **[PaperMod-FAQs](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)**
---
2023-02-04 13:28:07 +01:00
## Social-Icons/Share-Icons 🖼️
2023-02-04 13:28:07 +01:00
Read Wiki For More Details => **[PaperMod-Icons](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)**
2020-09-13 17:49:29 +02:00
2020-09-14 14:47:01 +02:00
---
2020-09-14 14:45:54 +02:00
## Release Changelog 📃
2020-10-28 18:11:42 +01:00
Release ChangeLog has info about stuff added: **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)**
2020-10-28 18:11:42 +01:00
---
## [Pagespeed Insights (100% ?)](https://pagespeed.web.dev/report?url=https://adityatelange.github.io/hugo-PaperMod/) 👀
2020-10-19 12:28:50 +02:00
---
2023-04-28 18:08:05 +02:00
## Support 🫶
- Star 🌟 this repository.
- Help spread the word about PaperMod by sharing it on social media and recommending it to your friends. 🗣️
- You can also sponsor 🏅 on [Github Sponsors](https://github.com/sponsors/adityatelange) / [Ko-Fi](https://ko-fi.com/adityatelange).
---
2020-12-15 19:31:44 +01: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 17:09:38 +02:00
- [**Simple Icons**](https://github.com/simple-icons/simple-icons)
- **All Contributors and Supporters**
2023-02-04 13:28:07 +01:00
---
## Stargazers over time 📈
<kbd>[![Stargazers over time](https://starchart.cc/adityatelange/hugo-PaperMod.svg)](https://starchart.cc/adityatelange/hugo-PaperMod)</kbd>