mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2023-12-21 10:22:58 +01:00
96 lines
3.9 KiB
Markdown
96 lines
3.9 KiB
Markdown
<h1 align=center>Hugo PaperMod | <a href="https://adityatelange.github.io/hugo-PaperMod/" rel="nofollow">Demo</a></h1>
|
|
|
|
<h4 align=center>☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive</h4>
|
|
<br>
|
|
|
|
> Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper).
|
|
> The goal of this project is to add more features and customization to the og theme.
|
|
|
|
**Documentation** can be found here: [**📚 Wiki**](https://github.com/adityatelange/hugo-PaperMod/wiki)
|
|
|
|
**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.
|
|
|
|
[](https://themes.gohugo.io/themes/hugo-papermod/)
|
|
[](https://github.com/gohugoio/hugo/releases/tag/v0.83.0)
|
|
[](https://discord.gg/ahpmTvhVmp)
|
|
[](https://github.com/adityatelange/hugo-PaperMod/blob/master/LICENSE)
|
|
|
|
|
|
---
|
|
|
|
<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>
|
|
</p>
|
|
|
|
---
|
|
|
|
## Features/Mods 💥
|
|
|
|
- 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.
|
|
- Social Icons (home-info and profile-mode)
|
|
- Social-Media Share buttons on posts.
|
|
- Menu location indicator.
|
|
- Multilingual support. (with language selector)
|
|
- Taxonomies
|
|
- Cover image for each post (with Responsive image support).
|
|
- Light/Dark theme (automatic theme switch a/c to browser theme and theme-switch button).
|
|
- SEO Friendly.
|
|
- Multiple Author support.
|
|
- Search Page with Fuse.js
|
|
- Other Posts suggestion below a post
|
|
- Breadcrumb Navigation
|
|
- Code Block Copy buttons
|
|
- 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)**
|
|
|
|
---
|
|
|
|
## Install/Update 📥
|
|
|
|
Read Wiki For More Details => **[PaperMod - Installation](https://github.com/adityatelange/hugo-PaperMod/wiki/Installation)**
|
|
|
|
---
|
|
|
|
## FAQs / How To's Guide 🙋
|
|
|
|
Read Wiki For More Details => **[PaperMod-FAQs](https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs)**
|
|
|
|
---
|
|
|
|
## Social-Icons/Share-Icons 🖼️
|
|
|
|
Read Wiki For More Details => **[PaperMod-Icons](https://github.com/adityatelange/hugo-PaperMod/wiki/Icons)**
|
|
|
|
---
|
|
|
|
## Release Changelog 📃
|
|
|
|
Release ChangeLog has info about stuff added: **[Releases](https://github.com/adityatelange/hugo-PaperMod/releases)**
|
|
|
|
---
|
|
|
|
## [Pagespeed Insights (100% ?)](https://pagespeed.web.dev/report?url=https://adityatelange.github.io/hugo-PaperMod/) 👀
|
|
|
|
---
|
|
|
|
## Special Thanks 🌟
|
|
|
|
- [**Highlight.js**](https://github.com/highlightjs/highlight.js)
|
|
- [**Fuse.js**](https://github.com/krisk/fuse)
|
|
- [**Feather Icons**](https://github.com/feathericons/feather)
|
|
- [**Simple Icons**](https://github.com/simple-icons/simple-icons)
|
|
- **All Contributors and Supporters**
|
|
|
|
---
|
|
|
|
## Stargazers over time 📈
|
|
|
|
<kbd>[](https://starchart.cc/adityatelange/hugo-PaperMod)</kbd>
|