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

View file

@ -6,8 +6,12 @@ weight: 1
aliases: ['/papermod-installation']
tags: ['PaperMod']
author: "Aditya Telange"
showToc: true
TocOpen: true
---
## Guide
Follow [this](https://gohugo.io/getting-started/quick-start/) guide to setup hugo and create a new site.
Make sure you install latest version of `hugo`(>=0.57.1).
@ -35,7 +39,7 @@ Inside the folder of your Hugo site, run:
> > git submodule update --remote --merge
> > ```
> >
Then change in `config.toml`:
Then change in `config.yml`:
>
```yml
theme: "hugo-PaperMod"
@ -45,6 +49,98 @@ Example Site Structure is present here: [exampleSite](https://github.com/adityat
---
### Sample `config.yml`
```yml
baseURL: 'https://examplesite.com'
title: ExampleSite
paginate: 5
theme: hugo-PaperMod
enableRobotsTXT: true
buildDrafts: false
buildFuture: false
buildExpored: false
googleAnalytics: UA-123-45
minify:
disableXML: true
minifyOutput: true
params:
env: production # to enable google analytics, opengraph, twitter-cards and schema.
title: ExampleSite
description: 'ExampleSite's description'
author: Me
images: "<link or path of image for opengraph, twitter-cards>"
ShowReadingTime: true
ShowShareButtons: true
comments: false
defaultTheme: auto
disableThemeToggle : false
disableSpecial1stPost : false
# profile-mode
profileMode:
enabled: false # needs to be explicitly set
title: ExampleSite
# imageUrl: '<img location>'
# imageTitle: my image
buttons:
- name: Posts
url: posts
- name: Tags
url: tags
# home-info mode
homeInfoParams:
Title: "Hi there \U0001F44B"
Content: Welcome to my blog
socialIcons:
- name: twitter
url: 'https://twitter.com/'
- name: stackoverflow
url: 'https://stackoverflow.com'
- name: github
url: 'https://github.com/'
analytics:
google:
SiteVerificationTag: "XYZabc"
```
---
### Sample `Page.md`
```yml
---
title: "My 1st post"
date: 2020-09-15T11:30:03+00:00
weight: 1
aliases: ['/first']
tags: ['first']
author: "Me"
showToc: true
TocOpen: false
draft: false
hidemeta: false
disableShare: false
cover:
image: '<image path/url>'
alt: '<alt text>'
caption: '<text>'
comments: false
---
```
---
### [Papermod - Features](../papermod-features)
### [Papermod - How to Guide](../papermod-how-to-guide)
### [Papermod - Icons](../papermod-icons)