mirror of
https://github.com/adityatelange/hugo-PaperMod.git
synced 2023-12-21 10:22:58 +01:00
Update demo
This commit is contained in:
Aditya Telange
parent
0dfff4e1ce
commit
ff475e3fd7
2
.gitignore
vendored
2
.gitignore
vendored
@ -24,3 +24,5 @@ _testmain.go
|
||||
|
||||
/public
|
||||
.DS_Store
|
||||
.hugo_build.lock
|
||||
resources/_gen/
|
||||
|
||||
BIN
assets/images/msg.png
Normal file
BIN
assets/images/msg.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 86 KiB |
102
config.yml
102
config.yml
@ -1,7 +1,9 @@
|
||||
baseURL: "https://adityatelange.github.io/hugo-PaperMod/" # if your site is in 'https', then make sure your base url isn't written using 'http' otherwise your sitemap would contain http (as opposeed to https) URLs. This would affect Google indexing of your URLs.
|
||||
# If your site is in 'https', then make sure your base url isn't written using 'http' otherwise your sitemap would
|
||||
# contain http (as opposeed to https) URLs. This would affect Google indexing of your URLs.
|
||||
baseURL: "https://adityatelange.github.io/hugo-PaperMod/"
|
||||
title: PaperMod
|
||||
paginate: 5
|
||||
theme: hugo-PaperMod
|
||||
theme: [hugo-PaperMod]
|
||||
|
||||
enableInlineShortcodes: true
|
||||
enableRobotsTXT: true
|
||||
@ -10,6 +12,7 @@ buildFuture: false
|
||||
buildExpired: false
|
||||
enableEmoji: true
|
||||
pygmentsUseClasses: true
|
||||
mainsections: ["posts", "papermod"]
|
||||
# googleAnalytics: UA-123-45
|
||||
|
||||
minify:
|
||||
@ -37,31 +40,15 @@ languages:
|
||||
weight: 10
|
||||
- name: WiKi
|
||||
url: https://github.com/adityatelange/hugo-PaperMod/wiki/
|
||||
- name: Discord
|
||||
url: https://discord.gg/ahpmTvhVmp
|
||||
|
||||
fr:
|
||||
languageName: ":fr:"
|
||||
languageAltTitle: French
|
||||
weight: 2
|
||||
title: PaperModL2
|
||||
taxonomies:
|
||||
category: FRcategories
|
||||
tag: FRtags
|
||||
series: FRseries
|
||||
profileMode:
|
||||
enabled: true
|
||||
title: PaperMod
|
||||
imageUrl: "https://raw.githubusercontent.com/twitter/twemoji/master/assets/svg/1f317.svg"
|
||||
imageTitle: ProfileMode image
|
||||
# imageWidth: 120
|
||||
# imageHeight: 120
|
||||
subtitle: "☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive"
|
||||
buttons:
|
||||
- name: Blog
|
||||
url: posts
|
||||
- name: Profile Mode
|
||||
url: https://github.com/adityatelange/hugo-PaperMod/wiki/Features#profile-mode
|
||||
menu:
|
||||
main:
|
||||
- name: Archive
|
||||
@ -79,13 +66,27 @@ languages:
|
||||
- name: NullLink
|
||||
url: "#"
|
||||
|
||||
# custom params for each language should be under [langcode].parms - hugo v0.120.0
|
||||
params:
|
||||
languageAltTitle: French
|
||||
profileMode:
|
||||
enabled: true
|
||||
title: PaperMod
|
||||
imageUrl: "https://raw.githubusercontent.com/googlefonts/noto-emoji/master/svg/emoji_u1f9d1_1f3fb_200d_1f4bb.svg"
|
||||
imageTitle: ProfileMode image
|
||||
# imageWidth: 120
|
||||
# imageHeight: 120
|
||||
subtitle: "☄️ Fast | ☁️ Fluent | 🌙 Smooth | 📱 Responsive"
|
||||
buttons:
|
||||
- name: Blog
|
||||
url: posts
|
||||
- name: Profile Mode
|
||||
url: https://github.com/adityatelange/hugo-PaperMod/wiki/Features#profile-mode
|
||||
|
||||
fa:
|
||||
languagedirection: rtl
|
||||
weight: 3
|
||||
title: PaperMod RTL
|
||||
homeInfoParams:
|
||||
Title: "Hi there \U0001F44B"
|
||||
Content: Welcome to RTL layout
|
||||
taxonomies:
|
||||
category: FAcategories
|
||||
tag: FAtags
|
||||
@ -95,6 +96,11 @@ languages:
|
||||
- name: FATags
|
||||
url: fatags
|
||||
weight: 10
|
||||
# custom params for each language should be under [langcode].parms - hugo v0.120.0
|
||||
params:
|
||||
homeInfoParams:
|
||||
Title: "Hi there \U0001F44B"
|
||||
Content: Welcome to RTL layout
|
||||
|
||||
outputs:
|
||||
home:
|
||||
@ -118,9 +124,11 @@ params:
|
||||
ShowBreadCrumbs: true
|
||||
ShowCodeCopyButtons: true
|
||||
ShowRssButtonInSectionTermList: true
|
||||
ShowAllPagesInArchive: true
|
||||
ShowPageNums: true
|
||||
ShowToc: true
|
||||
# comments: false
|
||||
images: ["papermod-cover.png"]
|
||||
images: ["images/papermod-cover.png"]
|
||||
|
||||
profileMode:
|
||||
enabled: false
|
||||
@ -136,23 +144,29 @@ params:
|
||||
url: tags
|
||||
|
||||
homeInfoParams:
|
||||
Title: "PaperMod"
|
||||
Title: "PaperMod's Demo"
|
||||
Content: >
|
||||
Welcome to demo of hugo's theme PaperMod.
|
||||
👋 Welcome to demo page of Hugo's theme PaperMod!
|
||||
|
||||
- **PaperMod** is a simple but fast and responsive theme with useful feature-set that enhances UX.
|
||||
- **PaperMod** is designed to be clean and simple but fast and responsive theme with useful feature-set that enhances UX.
|
||||
|
||||
- Do give a 🌟 on Github !
|
||||
- Feel free to show your support by giving us a star 🌟 on GitHub and sharing with your friends and social media .
|
||||
|
||||
- PaperMod is based on theme [Paper](https://github.com/nanxiaobei/hugo-paper).
|
||||
- PaperMod is based on theme [Paper](https://github.com/nanxiaobei/hugo-paper/tree/4330c8b12aa48bfdecbcad6ad66145f679a430b3).
|
||||
|
||||
socialIcons:
|
||||
- name: github
|
||||
title: View Source on Github
|
||||
url: "https://github.com/adityatelange/hugo-PaperMod"
|
||||
- name: Discord
|
||||
title: Join discord community
|
||||
url: "https://discord.gg/ahpmTvhVmp"
|
||||
- name: X
|
||||
title: Share PaperMod on X/Twitter
|
||||
url: "https://x.com/intent/tweet/?text=Checkout%20Hugo%20PaperMod%20%E2%9C%A8%0AA%20fast,%20clean,%20responsive%20Hugo%20theme.&url=https://github.com/adityatelange/hugo-PaperMod&hashtags=Hugo,PaperMod"
|
||||
- name: KoFi
|
||||
title: Buy me a Ko-Fi :)
|
||||
url: "https://ko-fi.com/adityatelange"
|
||||
- name: Rss
|
||||
url: "index.xml"
|
||||
|
||||
editPost:
|
||||
URL: "https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/content"
|
||||
@ -160,6 +174,7 @@ params:
|
||||
appendFilePath: true # to append file path to Edit link
|
||||
|
||||
# label:
|
||||
# iconSVG: '<svg xmlns="http://www.w3.org/2000/svg" height="25" viewBox="0 -960 960 960" fill="currentColor"><path d="M320-240h320v-80H320v80Zm0-160h320v-80H320v80ZM240-80q-33 0-56.5-23.5T160-160v-640q0-33 23.5-56.5T240-880h320l240 240v480q0 33-23.5 56.5T720-80H240Zm280-520v-200H240v640h480v-440H520ZM240-800v200-200 640-640Z"/></svg>'
|
||||
# text: "Home"
|
||||
# icon: icon.png
|
||||
# iconHeight: 35
|
||||
@ -188,7 +203,6 @@ params:
|
||||
# distance: 1000
|
||||
# threshold: 0.4
|
||||
# minMatchCharLength: 0
|
||||
# limit: 10 # refer: https://www.fusejs.io/api/methods.html#search
|
||||
# keys: ["title", "permalink", "summary", "content"]
|
||||
|
||||
markup:
|
||||
@ -203,23 +217,23 @@ markup:
|
||||
# lineNos: true
|
||||
# style: monokai
|
||||
|
||||
privacy:
|
||||
vimeo:
|
||||
disabled: false
|
||||
simple: true
|
||||
# privacy:
|
||||
# vimeo:
|
||||
# disabled: false
|
||||
# simple: true
|
||||
|
||||
twitter:
|
||||
disabled: false
|
||||
enableDNT: true
|
||||
simple: true
|
||||
# twitter:
|
||||
# disabled: false
|
||||
# enableDNT: true
|
||||
# simple: true
|
||||
|
||||
instagram:
|
||||
disabled: false
|
||||
simple: true
|
||||
# instagram:
|
||||
# disabled: false
|
||||
# simple: true
|
||||
|
||||
youtube:
|
||||
disabled: false
|
||||
privacyEnhanced: true
|
||||
# youtube:
|
||||
# disabled: false
|
||||
# privacyEnhanced: true
|
||||
|
||||
services:
|
||||
instagram:
|
||||
|
||||
@ -1,26 +0,0 @@
|
||||
timeout: 30000
|
||||
enableInlineShortcodes: true
|
||||
|
||||
taxonomies:
|
||||
category: categories
|
||||
tag: tags
|
||||
series: series
|
||||
|
||||
privacy:
|
||||
vimeo:
|
||||
disabled: false
|
||||
simple: true
|
||||
|
||||
twitter:
|
||||
disabled: false
|
||||
enableDNT: true
|
||||
simple: true
|
||||
disableInlineCSS: true
|
||||
|
||||
instagram:
|
||||
disabled: false
|
||||
simple: true
|
||||
|
||||
youtube:
|
||||
disabled: false
|
||||
privacyEnhanced: true
|
||||
152
content/posts/code_syntax.md
Normal file
152
content/posts/code_syntax.md
Normal file
@ -0,0 +1,152 @@
|
||||
---
|
||||
author: ["Aditya Telange"]
|
||||
title: "Code Syntax Guide"
|
||||
date: "2019-03-10"
|
||||
description: "Sample article showcasing basic code syntax and formatting for HTML elements."
|
||||
summary: "Sample article showcasing basic code syntax and formatting for HTML elements."
|
||||
tags: ["markdown", "syntax", "code", "gist"]
|
||||
categories: ["themes", "syntax"]
|
||||
series: ["Themes Guide"]
|
||||
ShowToc: true
|
||||
TocOpen: true
|
||||
---
|
||||
|
||||
### Inline Code
|
||||
|
||||
`This is Inline Code`
|
||||
|
||||
### Only `pre`
|
||||
|
||||
<pre>
|
||||
This is pre text
|
||||
</pre>
|
||||
|
||||
### Code block with backticks
|
||||
|
||||
```{hl_lines=[2,8]}
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Example HTML5 Document</title>
|
||||
<meta
|
||||
name="description"
|
||||
content="Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
||||
/>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
### Code block with backticks and language specified
|
||||
|
||||
```html
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Example HTML5 Document</title>
|
||||
<meta
|
||||
name="description"
|
||||
content="Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
||||
/>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
### Code block with backticks and language specified with line numbers
|
||||
|
||||
```html {linenos=true}
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Example HTML5 Document</title>
|
||||
<meta
|
||||
name="description"
|
||||
content="Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
||||
/>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
### Code block with line numbers and <mark>highlighted</mark> lines
|
||||
|
||||
- PaperMod supports `linenos=true` or `linenos=table`
|
||||
|
||||
```html {linenos=true,hl_lines=[2,8]}
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Example HTML5 Document</title>
|
||||
<meta
|
||||
name="description"
|
||||
content="Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
||||
/>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
- With `linenos=inline` line <mark>**might not** get highlighted</mark> properly.
|
||||
|
||||
```html {linenos=inline,hl_lines=[2,8]}
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Example HTML5 Document</title>
|
||||
<meta
|
||||
name="description"
|
||||
content="Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
||||
/>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
### Code block indented with four spaces
|
||||
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Example HTML5 Document</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
### Code block with Hugo's internal highlight shortcode
|
||||
|
||||
{{< highlight html >}}
|
||||
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Example HTML5 Document</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
{{< /highlight >}}
|
||||
|
||||
### Github Gist
|
||||
|
||||
{{< gist adityatelange 376cd56ee2c94aaa2e8b93200f2ba8b5 >}}
|
||||
@ -7,6 +7,9 @@ tags: ["markdown", "css", "html", "themes"]
|
||||
categories: ["themes", "syntax"]
|
||||
series: ["Themes Guide"]
|
||||
aliases: ["migrate-from-jekyl"]
|
||||
cover:
|
||||
image: images/msg.png
|
||||
caption: "Generated using [OG Image Playground by Vercel](https://og-playground.vercel.app/)"
|
||||
ShowToc: true
|
||||
TocOpen: true
|
||||
---
|
||||
@ -69,82 +72,6 @@ Tables aren't part of the core Markdown spec, but Hugo supports them out-of-the-
|
||||
| --------- | -------- | ------ |
|
||||
| _italics_ | **bold** | `code` |
|
||||
|
||||
## Code Blocks
|
||||
|
||||
#### Inline Code
|
||||
|
||||
`This is Inline Code`
|
||||
|
||||
#### Only `pre`
|
||||
|
||||
<pre>
|
||||
This is pre text
|
||||
</pre>
|
||||
|
||||
#### Code block with backticks
|
||||
|
||||
```
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Example HTML5 Document</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
#### Code block with backticks and language specified
|
||||
|
||||
```html {linenos=true}
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>Example HTML5 Document</title>
|
||||
<meta name="description" content="Sample article showcasing basic Markdown syntax and formatting for HTML elements.">
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
```
|
||||
|
||||
#### Code block indented with four spaces
|
||||
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Example HTML5 Document</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
#### Code block with Hugo's internal highlight shortcode
|
||||
|
||||
{{< highlight html >}}
|
||||
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Example HTML5 Document</title>
|
||||
</head>
|
||||
<body>
|
||||
<p>Test</p>
|
||||
</body>
|
||||
</html>
|
||||
{{< /highlight >}}
|
||||
|
||||
#### Gist
|
||||
|
||||
{{< gist spf13 7896402 >}}
|
||||
|
||||
## List Types
|
||||
|
||||
#### Ordered List
|
||||
@ -159,7 +86,7 @@ This is pre text
|
||||
- Another item
|
||||
- And another item
|
||||
|
||||
#### Nested list
|
||||
#### Nested Unordered list
|
||||
|
||||
- Fruit
|
||||
- Apple
|
||||
@ -169,6 +96,19 @@ This is pre text
|
||||
- Milk
|
||||
- Cheese
|
||||
|
||||
#### Nested Ordered list
|
||||
|
||||
1. Fruit
|
||||
- Apple
|
||||
- Orange
|
||||
- Banana
|
||||
2. Dairy
|
||||
1. Milk
|
||||
2. Cheese
|
||||
3. Third item
|
||||
1. Sub One
|
||||
2. Sub Two
|
||||
|
||||
## Other Elements — abbr, sub, sup, kbd, mark
|
||||
|
||||
<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.
|
||||
|
||||
@ -1,20 +1,18 @@
|
||||
---
|
||||
title: "FAQs"
|
||||
summary: Frequently Asked Questions
|
||||
title: "FAQs / How To's Guide"
|
||||
summary: We'll try to answer frequently asked qestions by users.
|
||||
date: 2021-01-20
|
||||
aliases: ["/papermod-how-to-guide"]
|
||||
tags: ["PaperMod"]
|
||||
author: "Aditya Telange"
|
||||
tags: ["PaperMod", "Docs"]
|
||||
author: ["PaperMod Contributors"]
|
||||
draft: true
|
||||
aliases: [/posts/papermod/papermod-how-to]
|
||||
weight: 3
|
||||
---
|
||||
|
||||
## Intro
|
||||
|
||||
- **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.**
|
||||
|
||||
- You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary.
|
||||
> - **We'll be using `yml/yaml` format for all examples down below, I recommend using `yml` over `toml` as it is easier to read.**
|
||||
>
|
||||
> - You can find any [YML to TOML](https://www.google.com/search?q=yml+to+toml) converters if necessary.
|
||||
|
||||
---
|
||||
|
||||
@ -43,7 +41,7 @@ When Hugo builds your site, your copy of `list.html` will be used instead of the
|
||||
|
||||
These include OpenGraph, Twitter Cards and Schema.
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
env: production
|
||||
```
|
||||
@ -62,7 +60,7 @@ Why was the `asset` not loading ? : [How_browsers_handle_Subresource_Integrity](
|
||||
|
||||
Set the following in `config.yml`
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
assets:
|
||||
disableFingerprinting: true
|
||||
@ -135,7 +133,7 @@ You can add menu entries which will appear in the header of every page.
|
||||
|
||||
To do so, add a `menu` section to your site's `config.yml`:
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
menu:
|
||||
main:
|
||||
- identifier: categories
|
||||
@ -166,22 +164,20 @@ Post can be pinned/ displayed top on the list by adding a `weight=<num>` var to
|
||||
|
||||
example:
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
---
|
||||
title: "My Important post"
|
||||
date: 2020-09-15T11:30:03+00:00
|
||||
weight: 1
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
---
|
||||
title: "My 2nd Important post"
|
||||
date: 2020-09-15T11:30:03+00:00
|
||||
weight: 2
|
||||
---
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
@ -197,15 +193,13 @@ and can be added accordingly.
|
||||
- `apple-touch-icon.png`
|
||||
- `safari-pinned-tab.svg`
|
||||
|
||||
1. Favicon(s) can be generated by [Favicon.io](https://favicon.io)
|
||||
|
||||
and can be simply put in `/static` folder.
|
||||
1. Favicon(s) can be generated by [Favicon.io](https://favicon.io) and can be simply put in `/static` folder.
|
||||
|
||||
2. Other way is to add favicon(s) NOT located in `/static` folder.
|
||||
|
||||
In site config add the following:
|
||||
|
||||
```
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
assets:
|
||||
favicon: "<link / absolute url>"
|
||||
@ -215,19 +209,17 @@ and can be added accordingly.
|
||||
safari_pinned_tab: "<link / absolute url>"
|
||||
```
|
||||
|
||||
- `absolute url` means direct links to external resource: ex. https://web.site/someimage.png
|
||||
Note: `absolute url` means direct links to external resource: ex. `https://web.site/someimage.png`
|
||||
|
||||
example:
|
||||
|
||||
```
|
||||
params:
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
assets:
|
||||
favicon: "/favicon.ico"
|
||||
favicon16x16: "/favicon-16x16.png"
|
||||
favicon32x32: "/favicon-32x32.png"
|
||||
apple_touch_icon: "/apple-touch-icon.png"
|
||||
safari_pinned_tab: "/safari-pinned-tab.svg"
|
||||
```
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
@ -235,7 +227,7 @@ and can be added accordingly.
|
||||
|
||||
Add `#center` after image to center align an image
|
||||
|
||||
```md
|
||||
```md {linenos=true}
|
||||
|
||||
```
|
||||
|
||||
@ -243,9 +235,7 @@ Add `#center` after image to center align an image
|
||||
|
||||
use `align=center` to center image with captions
|
||||
|
||||
ex.
|
||||
|
||||
```md
|
||||
```md {linenos=true}
|
||||
{{</* figure align=center src="image.jpg" */>}}
|
||||
```
|
||||
|
||||
@ -255,7 +245,7 @@ ex.
|
||||
|
||||
1. Disable Highlight.js in site `config.yml`
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
assets:
|
||||
disableHLJS: true
|
||||
@ -263,7 +253,7 @@ ex.
|
||||
|
||||
2. Set hugo's markdown styling in site `config.yml`
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
markup:
|
||||
highlight:
|
||||
# anchorLineNos: true
|
||||
@ -280,7 +270,7 @@ ex.
|
||||
|
||||
Add the following to `assets/css/extended/custom.css`
|
||||
|
||||
```css
|
||||
```css {linenos=true}
|
||||
.chroma {
|
||||
background-color: unset;
|
||||
}
|
||||
@ -302,7 +292,7 @@ We have used this insted of assigning `baseURL` so as to work with multilingual
|
||||
|
||||
To fix for _single_ language websites hosting assets from CDN, this you may [override](#override-theme-template) [fastsearch.js#L35](https://github.com/adityatelange/hugo-PaperMod/blob/fb4988cfb6d0d6e4e489f17d89f0fa618def3396/assets/js/fastsearch.js#L35) and placing appropriate URL as in
|
||||
|
||||
```js
|
||||
```js {linenos=true}
|
||||
xhr.open("GET", "https://example.com/index.json");
|
||||
```
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
title: "Features"
|
||||
title: "Features / Mods"
|
||||
summary: Learn About All Features in PaperMod
|
||||
date: 2021-01-20
|
||||
weight: 2
|
||||
aliases: ["/papermod-features"]
|
||||
tags: ["PaperMod"]
|
||||
author: "Aditya Telange"
|
||||
tags: ["PaperMod", "Docs"]
|
||||
author: ["Aditya Telange"]
|
||||
---
|
||||
|
||||
### Intro
|
||||
@ -28,7 +28,7 @@ The following is enabled by default
|
||||
|
||||
### Default Theme light/dark/auto
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
# defaultTheme: light
|
||||
# defaultTheme: dark
|
||||
@ -45,7 +45,7 @@ Shows icon besides title of page to change theme
|
||||
|
||||
To disable it :
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
disableThemeToggle: true
|
||||
```
|
||||
|
||||
@ -131,7 +131,7 @@ Shows Index/Home page as Full Page with Social Links and Image
|
||||
|
||||
add following to config file
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
profileMode:
|
||||
enabled: true
|
||||
@ -162,20 +162,20 @@ PaperMod uses [Fuse.js Basic](https://fusejs.io/getting-started/different-builds
|
||||
|
||||
Add the following to site config, `config.yml`
|
||||
|
||||
```yml
|
||||
```yml {linenos=true,hl_lines=[5]}
|
||||
outputs:
|
||||
home:
|
||||
- HTML
|
||||
- RSS
|
||||
- JSON # is necessary
|
||||
- JSON # necessary for search
|
||||
```
|
||||
|
||||
Create a page with `search.md` in `content` directory with following content
|
||||
|
||||
```yml
|
||||
```yml {linenos=true,hl_lines=[3]}
|
||||
---
|
||||
title: "Search" # in any language you want
|
||||
layout: "search" # is necessary
|
||||
layout: "search" # necessary for search
|
||||
# url: "/archive"
|
||||
# description: "Description for Search"
|
||||
summary: "search"
|
||||
@ -185,8 +185,7 @@ placeholder: "placeholder text in search input box"
|
||||
|
||||
To hide a particular page from being searched, add it in post's frontmatter
|
||||
|
||||
```yml
|
||||
---
|
||||
```yml {linenos=true}
|
||||
searchHidden: true
|
||||
```
|
||||
|
||||
@ -206,7 +205,7 @@ For Multilingual use `search.<lang>.md` ex. `search.es.md`.
|
||||
|
||||
Refer https://fusejs.io/api/options.html for Options, Add those as shown below.
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
fuseOpts:
|
||||
isCaseSensitive: false
|
||||
@ -231,7 +230,7 @@ adds `[draft]` mark to indicate draft pages.
|
||||
|
||||
In post's page-variables add :
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
cover:
|
||||
image: "<image path/url>"
|
||||
# can also paste direct link from external site
|
||||
@ -245,7 +244,7 @@ When you include images in the [Page Bundle](https://gohugo.io/content-managemen
|
||||
|
||||
To reduce generation time and size of the site, you can disable this feature using
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
cover:
|
||||
responsiveImages: false
|
||||
@ -253,7 +252,7 @@ params:
|
||||
|
||||
To enable hyperlinks to the full image size on post pages, use
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
cover:
|
||||
linkFullImages: true
|
||||
@ -350,13 +349,13 @@ editPost:
|
||||
```
|
||||
|
||||
The example above would yield the following link for the post file `posts/post-name.md`:
|
||||
https://github.com/<path_to_repo>/content/posts/post-name.md
|
||||
`https://github.com/<path_to_repo>/content/posts/post-name.md`
|
||||
|
||||
| Parameter | Required | Default Value |
|
||||
| ----------------------- | -------- | ------------- |
|
||||
| editPost.URL | true | - |
|
||||
| editPost.appendFilePath | false | false |
|
||||
| editPost.Text | false | "Edit" |
|
||||
| ------------------------- | -------- | ------------- |
|
||||
| `editPost.URL` | true | - |
|
||||
| `editPost.appendFilePath` | false | `false` |
|
||||
| `editPost.Text` | false | `Edit` |
|
||||
|
||||
Since the link generated is a regular HTML anchor tag `<a href=...>`, you can
|
||||
also use other URL schemas like `mailto://`, e.g.
|
||||
@ -446,46 +445,47 @@ t - Theme toggle
|
||||
|
||||
#### Twitter Cards Support
|
||||
|
||||
* The Twitter Cards metadata, except ``twitter:image`` should not require
|
||||
- The Twitter Cards metadata, except `twitter:image` should not require
|
||||
additional configuration, since it is generated from metadata that
|
||||
you should already have (for instance the page title and description).
|
||||
* The ``twitter:image`` uses the [Post Cover Image](#post-cover-image), if present.
|
||||
* In the absence of a cover images, the first image from the ``images``
|
||||
- The `twitter:image` uses the [Post Cover Image](#post-cover-image), if present.
|
||||
- In the absence of a cover images, the first image from the `images`
|
||||
frontmatter (a list) is used.
|
||||
```yaml
|
||||
images:
|
||||
- image_01.png
|
||||
- image_02.png
|
||||
```
|
||||
* Finally, if neither of those are provided, ``twitter:image`` comes from the first
|
||||
- Finally, if neither of those are provided, `twitter:image` comes from the first
|
||||
[Page Bundle](https://gohugo.io/content-management/page-bundles/)
|
||||
image with ``feature`` in the name, with a fallback to the first image with
|
||||
``cover`` or ``thumbnail`` in the name.
|
||||
image with `feature` in the name, with a fallback to the first image with
|
||||
`cover` or `thumbnail` in the name.
|
||||
|
||||
#### OpenGraph support
|
||||
|
||||
* The OpenGraph metadata, except ``og:image`` should not require
|
||||
- The OpenGraph metadata, except `og:image` should not require
|
||||
additional configuration, since it is generated from metadata that
|
||||
you should already have (for instance the page title and description).
|
||||
* The ``og:image`` uses the [Post Cover Image](#post-cover-image), if present.
|
||||
* In the absence of a cover images, the first image from the ``images``
|
||||
- The `og:image` uses the [Post Cover Image](#post-cover-image), if present.
|
||||
- In the absence of a cover images, the first image from the `images`
|
||||
frontmatter (a list) is used.
|
||||
```yaml
|
||||
images:
|
||||
- image_01.png
|
||||
- image_02.png
|
||||
```
|
||||
* Finally, if neither of those are provided, ``og:image`` comes from the first
|
||||
- Finally, if neither of those are provided, `og:image` comes from the first
|
||||
[Page Bundle](https://gohugo.io/content-management/page-bundles/)
|
||||
image with ``feature`` in the name, with a fallback to the first image with
|
||||
``cover`` or ``thumbnail`` in the name.
|
||||
* For pages, you can also add audio (using frontmatter ``audio: filename.ext``) and/or
|
||||
image with `feature` in the name, with a fallback to the first image with
|
||||
`cover` or `thumbnail` in the name.
|
||||
- For pages, you can also add audio (using frontmatter `audio: filename.ext`) and/or
|
||||
videos.
|
||||
```yaml
|
||||
videos:
|
||||
- filename01.mov
|
||||
- filename02.avi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Multilingual Support
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
title: "Icons"
|
||||
title: "Social-Icons / Share-Icons"
|
||||
summary: List of all Icons supported by PaperMod
|
||||
date: 2021-01-20
|
||||
weight: 4
|
||||
aliases: ["/papermod-icons"]
|
||||
tags: ["PaperMod"]
|
||||
author: "Aditya Telange"
|
||||
tags: ["PaperMod", "Docs"]
|
||||
author: ["Aditya Telange"]
|
||||
draft: true
|
||||
---
|
||||
|
||||
@ -92,7 +92,7 @@ draft: true
|
||||
|
||||
Usage :
|
||||
|
||||
```
|
||||
```yml {linenos=true}
|
||||
socialIcons:
|
||||
- name: "kofi"
|
||||
url: "https://kofi.com"
|
||||
@ -105,8 +105,8 @@ socialIcons:
|
||||
## Share Icons
|
||||
|
||||
| Platform |
|
||||
| --------------------------------------------------------------- |
|
||||
| `twitter` (also generates hash tags from tags linked with post) |
|
||||
| ------------------------------------------------------------------- |
|
||||
| `twitter` (also generates `#hashtags` from _tags_ linked with post) |
|
||||
| `linkedin` |
|
||||
| `reddit` |
|
||||
| `facebook` |
|
||||
@ -115,12 +115,12 @@ socialIcons:
|
||||
|
||||
Usage:
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
ShowShareButtons: true
|
||||
```
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
params:
|
||||
ShareButtons: ["linkedin", "twitter"] # To customize which share buttons to be enabled on page
|
||||
```
|
||||
|
||||
@ -1,12 +1,15 @@
|
||||
---
|
||||
title: "Installation | Update"
|
||||
summary: Read Install and Update instructions here
|
||||
title: "Install / Update PaperMod"
|
||||
summary: Read aboout Install and Update instructions and sampled configuration templates
|
||||
date: 2021-01-20
|
||||
series: ["PaperMod"]
|
||||
weight: 1
|
||||
aliases: ["/papermod-installation"]
|
||||
tags: ["PaperMod"]
|
||||
author: "Aditya Telange"
|
||||
tags: ["PaperMod", "Docs"]
|
||||
author: ["Aditya Telange"]
|
||||
cover:
|
||||
image: images/papermod-cover.png
|
||||
hiddenInList: true
|
||||
---
|
||||
|
||||
## Intro
|
||||
@ -22,7 +25,7 @@ Follow [Quick Start](https://gohugo.io/getting-started/quick-start/) guide to se
|
||||
|
||||
> Note: Use -f to select yml format
|
||||
>
|
||||
> `hugo new site <name of site> -f yml`
|
||||
> `hugo new site <name of site> --format yaml`
|
||||
|
||||
Make sure you install latest version of **`hugo(>=0.83.0)`**.
|
||||
|
||||
@ -78,22 +81,23 @@ Direct Links:
|
||||
|
||||
### Method 4
|
||||
|
||||
- Install [Go programming language](https://go.dev/doc/install) in your operating system.
|
||||
- Install [Go programming language](https://go.dev/doc/install) in your operating system.
|
||||
|
||||
- Intialize your own hugo mod
|
||||
- Intialize your own hugo mod
|
||||
|
||||
```
|
||||
hugo mod init YOUR_OWN_GIT_REPOSITORY
|
||||
```
|
||||
|
||||
- Add PaperMod in your `config.yml` file
|
||||
- Add PaperMod in your `config.yml` file
|
||||
|
||||
```
|
||||
```go {linenos=true}
|
||||
module:
|
||||
imports:
|
||||
- path: github.com/adityatelange/hugo-PaperMod
|
||||
```
|
||||
- Update theme
|
||||
|
||||
- Update theme
|
||||
|
||||
```
|
||||
hugo mod get -u
|
||||
@ -103,13 +107,13 @@ hugo mod get -u
|
||||
|
||||
Add in `config.yml`:
|
||||
|
||||
```yml
|
||||
```yml {linenos=true}
|
||||
theme: "PaperMod"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Videos featuring Papermod
|
||||
## Videos featuring PaperMod
|
||||
|
||||
You can go through few videos which are available on YouTube for getting to know the creator's thoughts as well as the setup process.
|
||||
|
||||
|
||||
@ -2,8 +2,8 @@
|
||||
title: "Variables | Front Matter"
|
||||
summary: List of Front Matter variables used by PaperMod
|
||||
date: 2021-01-20
|
||||
tags: ["PaperMod"]
|
||||
author: "Aditya Telange"
|
||||
tags: ["PaperMod", "Docs"]
|
||||
author: ["Aditya Telange"]
|
||||
draft: true
|
||||
weight: 5
|
||||
---
|
||||
|
||||
@ -1,47 +0,0 @@
|
||||
---
|
||||
author: "Hugo Authors"
|
||||
title: "Placeholder Text"
|
||||
date: "2019-03-09"
|
||||
description: "Lorem Ipsum Dolor Si Amet"
|
||||
tags: ["markdown", "text"]
|
||||
hideMeta: true
|
||||
searchHidden: true
|
||||
ShowBreadCrumbs: false
|
||||
---
|
||||
|
||||
Lorem est tota propiore conpellat pectoribus de pectora summo. <!--more-->Redit teque digerit hominumque toris verebor lumina non cervice subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.
|
||||
|
||||
1. Exierant elisi ambit vivere dedere
|
||||
2. Duce pollice
|
||||
3. Eris modo
|
||||
4. Spargitque ferrea quos palude
|
||||
|
||||
Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.
|
||||
|
||||
1. Comas hunc haec pietate fetum procerum dixit
|
||||
2. Post torum vates letum Tiresia
|
||||
3. Flumen querellas
|
||||
4. Arcanaque montibus omnes
|
||||
5. Quidem et
|
||||
|
||||
# Vagus elidunt
|
||||
|
||||
<svg class="canon" xmlns="http://www.w3.org/2000/svg" overflow="visible" viewBox="0 0 496 373" height="373" width="496"><g fill="none"><path stroke="#000" stroke-width=".75" d="M.599 372.348L495.263 1.206M.312.633l494.95 370.853M.312 372.633L247.643.92M248.502.92l246.76 370.566M330.828 123.869V1.134M330.396 1.134L165.104 124.515"></path><path stroke="#ED1C24" stroke-width=".75" d="M275.73 41.616h166.224v249.05H275.73zM54.478 41.616h166.225v249.052H54.478z"></path><path stroke="#000" stroke-width=".75" d="M.479.375h495v372h-495zM247.979.875v372"></path><ellipse cx="498.729" cy="177.625" rx=".75" ry="1.25"></ellipse><ellipse cx="247.229" cy="377.375" rx=".75" ry="1.25"></ellipse></g></svg>
|
||||
|
||||
[The Van de Graaf Canon](https://en.wikipedia.org/wiki/Canons_of_page_construction#Van_de_Graaf_canon)
|
||||
|
||||
## Mane refeci capiebant unda mulcebat
|
||||
|
||||
Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. **Faces illo pepulere** tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis.
|
||||
|
||||
Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae vulnus haerentia iuste et exercebat, sui et.
|
||||
|
||||
Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel **mitis temploque** vocatus, inque alis, _oculos nomen_ non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem Propoetides **parte**.
|
||||
|
||||
{{< css.inline >}}
|
||||
|
||||
<style>
|
||||
.canon { background: white; width: 100%; height: auto; }
|
||||
</style>
|
||||
|
||||
{{< /css.inline >}}
|
||||
@ -1,32 +1,36 @@
|
||||
---
|
||||
author: "Hugo Authors"
|
||||
title: "Rich Content"
|
||||
author: ["Hugo Authors", "PaperMod Contributors"]
|
||||
title: "Rich Content and Shortcodes"
|
||||
date: "2019-03-10"
|
||||
description: "A brief description of Hugo Shortcodes"
|
||||
tags: ["shortcodes", "privacy"]
|
||||
tags: ["markdown", "shortcodes", "privacy"]
|
||||
ShowToc: true
|
||||
---
|
||||
|
||||
Hugo ships with several [Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes) for rich content, along with a [Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds.
|
||||
|
||||
<!--more-->
|
||||
---
|
||||
|
||||
## YouTube Privacy Enhanced Shortcode
|
||||
|
||||
{{< youtube ZJthWmvUzzc >}}
|
||||
|
||||
<br>
|
||||
|
||||
---
|
||||
|
||||
## Twitter Simple Shortcode
|
||||
## Figure Shortcode ([PaperMod enhanced](https://github.com/adityatelange/hugo-PaperMod/commits/master/layouts/shortcodes/figure.html))
|
||||
|
||||
{{< twitter_simple 1085870671291310081 >}}
|
||||
|
||||
<br>
|
||||
{{< figure src="https://source.unsplash.com/Z0lL0okYjy0" attr="Photo by [Aditya Telange](https://unsplash.com/@adityatelange?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash) on [Unsplash](https://unsplash.com/photos/Z0lL0okYjy0?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash)" align=center link="https://unsplash.com/photos/Z0lL0okYjy0" target="_blank" >}}
|
||||
|
||||
---
|
||||
|
||||
## Vimeo Simple Shortcode
|
||||
## YouTube
|
||||
|
||||
{{< vimeo_simple 48912912 >}}
|
||||
{{< youtube hjD9jTi_DQ4 >}}
|
||||
|
||||
---
|
||||
|
||||
## Twitter Shortcode
|
||||
|
||||
{{< twitter adityatelange 1724414854348357922 >}}
|
||||
|
||||
---
|
||||
|
||||
## Vimeo Shortcode
|
||||
|
||||
{{< vimeo 152985022 >}}
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
---
|
||||
title: "Search"
|
||||
placeholder: Search demo site with full text fuzzy search ...
|
||||
layout: "search"
|
||||
---
|
||||
|
||||
Loading…
Reference in New Issue
Block a user