hugo-PaperMod/content/posts/papermod/papermod-installation.md

157 lines
3.1 KiB
Markdown
Raw Normal View History

2020-09-17 04:58:09 -04:00
---
title: "Papermod - Installation"
date: 2020-09-15T11:30:03+05:30
series: ["PaperMod"]
weight: 1
aliases: ['/papermod-installation']
tags: ['PaperMod']
author: "Aditya Telange"
2020-10-06 03:31:20 -04:00
showToc: true
TocOpen: true
2020-09-17 04:58:09 -04:00
---
2020-10-06 03:31:20 -04:00
## Guide
2020-09-17 04:58:09 -04:00
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).
After you have created a new site, at [Step 3](https://gohugo.io/getting-started/quick-start/#step-3-add-a-theme) follow the steps:
Inside the folder of your Hugo site, run:
> ```console
> git clone https://github.com/adityatelange/hugo-PaperMod themes/hugo-PaperMod --depth=1
> ```
> > Updating theme :
> > ```console
> > cd themes/hugo-PaperMod
> > git pull
> > ```
> >
**or** you can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule) with
>
> ```console
> git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/hugo-PaperMod
2020-10-10 10:31:05 -04:00
> git submodule update --init --recursive
2020-09-17 04:58:09 -04:00
> ```
> > Updating theme with submodule :
> > ```console
> > git submodule update --remote --merge
> > ```
> >
2020-10-06 03:31:20 -04:00
Then change in `config.yml`:
2020-09-17 04:58:09 -04:00
>
```yml
theme: "hugo-PaperMod"
```
Example Site Structure is present here: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/)
---
2020-10-06 03:31:20 -04:00
### 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
2020-10-16 14:42:45 -04:00
assets:
favicon: '<path / external url>'
label:
text: "Home"
icon: /apple-touch-icon.png
iconHeight: 35
2020-10-06 03:31:20 -04:00
# 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>'
2020-10-10 10:31:05 -04:00
relative: false
2020-10-06 03:31:20 -04:00
comments: false
---
```
---
2020-09-17 05:13:23 -04:00
### [Papermod - Features](../papermod-features)
### [Papermod - How to Guide](../papermod-how-to-guide)
2020-10-16 14:42:45 -04:00
### [Papermod - Icons](../papermod-icons)