mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2024-12-29 08:03:18 -05:00
3.6 KiB
3.6 KiB
title | summary | date | series | weight | aliases | tags | author | showToc | TocOpen | |||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Papermod - Installation | Read Install and Update instructions here | 2020-09-15T11:30:03+05:30 |
|
1 |
|
|
Aditya Telange | true | true |
Guide
Follow this guide to setup hugo and create a new site.
Make sure you install latest version of hugo
(>=0.74.0).
After you have created a new site, at Step 3 follow the steps:
Inside the folder of your Hugo site, run:
git clone https://github.com/adityatelange/hugo-PaperMod themes/hugo-PaperMod --depth=1
Updating theme :
cd themes/hugo-PaperMod git pull
or you can use as submodule with
git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/hugo-PaperMod git submodule update --init --recursive
Updating theme with submodule :
git submodule update --remote --merge
Then change in
config.yml
:
theme: "hugo-PaperMod"
Example Site Structure is present here: exampleSite
Sample config.yml
baseURL: "https://examplesite.com"
title: ExampleSite
paginate: 5
theme: hugo-PaperMod
enableRobotsTXT: true
buildDrafts: false
buildFuture: false
buildExpired: 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 description"
author: Me
# author: ["Me", "You"] # multiple authors
images: "<link or path of image for opengraph, twitter-cards>"
ShowReadingTime: true
ShowShareButtons: true
comments: false
defaultTheme: auto
disableThemeToggle: false
disableSpecial1stPost: false
assets:
favicon: "<link / abs url>"
favicon16x16: "<link / abs url>"
favicon32x32: "<link / abs url>"
apple_touch_icon: "<link / abs url>"
safari_pinned_tab: "<link / abs url>"
label:
text: "Home"
icon: /apple-touch-icon.png
iconHeight: 35
# 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
---
title: "My 1st post"
date: 2020-09-15T11:30:03+00:00
weight: 1
aliases: ["/first"]
tags: ["first"]
author: "Me"
# author: ["Me", "You"] # multiple authors
showToc: true
TocOpen: false
draft: false
hidemeta: false
disableShare: false
cover:
image: "<image path/url>"
alt: "<alt text>"
caption: "<text>"
relative: false
comments: false
---