mirrors/hugo-PaperMod
1
0
Fork 0
mirror of https://github.com/adityatelange/hugo-PaperMod.git synced 2025-05-23 03:06:54 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

2.0 docs

Browse source
This commit is contained in:
Aditya Telange 2020-10-06 13:01:20 +05:30
parent 2aa462cf67
commit ccaca9896c
No known key found for this signature in database
GPG key ID: 82E844EF3DA99E77
3 changed files with 152 additions and 56 deletions
Download patch file Download diff file Expand all files Collapse all files

100
content/posts/papermod/papermod-features.md
View file

@ -9,7 +9,7 @@ author: "Aditya Telange"
tocopen: true
---
## Assets (js/css)
### Assets (js/css)
The following is enabled by default
- [minification](https://gohugo.io/hugo-pipes/minification/) - makes the assets size smallest as possible.
- [bundling](https://gohugo.io/hugo-pipes/bundling/) - bundles all the styles in one single asset
@ -17,44 +17,43 @@ The following is enabled by default
---
## Default Theme light/dark
```yml
params:
defaultTheme: light
```
or
```yml
params:
defaultTheme: dark
```
or
### Default Theme light/dark/auto
```yml
params:
# defaultTheme: light
# defaultTheme: dark
defaultTheme: auto # to switch between dark or light according to browser theme
```
</details>
---
## Archives Layout
### Theme Switch Toggle (enabled by default)
Add vars below to page-variables
Shows icon besides title of page to change theme
To disable it :
```yml
disableThemeToggle : true
```
---
### Archives Layout
Create a page with `archive.md`
Add vars below to its page-variables
```yml
layout: "archives"
```
ex: [here](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/archives.md)
![](https://i.ibb.co/cNWc7GZ/paper-mod-archives.png)
ex: [archives.md](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/archives.md)
---
## Home-Info Mode
### Home-Info Mode
Use 1st entry as some Information
@ -78,7 +77,7 @@ ex. [here](https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/confi
---
## Profile Mode
### Profile Mode
Shows Index/Home page as Full Page with Social Links and Image
@ -108,33 +107,28 @@ params:
---
## [Draft](https://gohugo.io/getting-started/usage/#draft-future-and-expired-content) Page indication
### Draft Page indication
adds `[draft]` mark to indicate draft pages.
---
## Cover for a Post
### Post Cover Image
In post's page-variables add :
```yml
cover = "<absolute image url>"
# can also paste direct link from external site
# ex. https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png
cover:
image: '<image path/url>'
# can also paste direct link from external site
# ex. https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png
alt: '<alt text>'
caption: '<text>'
```
![](https://user-images.githubusercontent.com/21258296/93084795-3579ae80-f6b2-11ea-98c1-eee4061eb836.png)
---
## Scroll-to-Top Button (by default)
Displays a Scroll-to-Top button in right-bottom corner
---
## Share Buttons on post
### Share Buttons on post
Displays Share Buttons at Bottom of each post
@ -144,11 +138,9 @@ params:
ShowShareButtons: true
```
![](https://i.ibb.co/sPN8bgd/paper-mod-share-butons.png)
---
## Show post reading time
### Show post reading time
Displays Reading Time (the estimated time, in minutes, it takes to read the content.)
@ -160,7 +152,7 @@ Params:
---
## Show Table of Contents (Toc) on blog post
### Show Table of Contents (Toc) on blog post
Displays ToC on blog-pages
@ -176,7 +168,7 @@ TocOpen: true
---
## Comments
### Comments
to add comments, create a html file
@ -195,8 +187,26 @@ read more about this [here](https://gohugo.io/content-management/comments/)
---
## Scroll-Bar themed (by default)
### Misc
---
#### Scroll-Bar themed (by default)
## Smooth Scroll between in-page links (by default)
#### Smooth Scroll between in-page links (by default)
#### Scroll-to-Top Button (by default)
Displays a Scroll-to-Top button in right-bottom corner
#### Google Analytics integration
#### Open-Graph support
#### Twitter Cards Support
#### Syntax highlighting
#### Twitter cards and opengraph tags support
#### RSS feeds
#### Multilingual Support