mirrors/hugo-PaperMod
1
0
Fork 0
mirror of https://github.com/adityatelange/hugo-PaperMod.git synced 2023-12-21 10:22:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

update docs from wiki

Browse Source
This commit is contained in:
Aditya Telange 2021-03-28 10:05:47 +05:30
parent 2dae7281f3
commit b85471e946
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
3 changed files with 135 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
content/posts/papermod/papermod-features/index.md
View File

@ -327,6 +327,47 @@ ShowBreadCrumbs: false
---
### Edit Link for Posts
Add a button to suggest changes by using the file path of the post to link to a edit destination.
For site config use:
```yml
Params:
editPost:
URL: "https://github.com/<path_to_repo>/content"
Text: "Suggest Changes" # edit text
appendFilePath: true # to append file path to Edit link
```
Can be modified for individual pages
```yml
---
editPost:
URL: "https://github.com/<path_to_repo>/content"
Text: "Suggest Changes" # edit text
appendFilePath: true # to append file path to Edit link
---
```
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
| Parameter | Required | Default Value |
| ----------------------- | -------- | ------------- |
| 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.
`URL: "mailto://mail@example.com?subject=Suggesting changes for "`
---
### Other Posts suggestion below a post
Adds a Previous / Next post suggestion under a single post

59
content/posts/papermod/papermod-icons.md
View File

@ -29,34 +29,37 @@ draft: true
| 14 | `freepik` | freepik.com |
| 15 | `github` | github.com |
| 16 | `gitlab` | gitlab.com |
| 17 | `hackerrank` | hackerrank.com |
| 18 | `hackthebox` | hackthebox.eu |
| 19 | `instagram` | instagram.com |
| 20 | `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| 21 | `keybase` | keybase.io |
| 22 | `kofi` | ko-fi.com |
| 23 | `lastfm` | last.fm |
| 24 | `linkedin` | linkedin.com |
| 25 | `mastodon` | mastodon.social |
| 26 | `medium` | medium.com |
| 27 | `mixcloud` | mixcloud.com |
| 28 | `nuget` | nuget.org |
| 29 | `paypal` | paypal.com |
| 30 | `qq` | qq.com |
| 31 | `reddit` | reddit.com |
| 32 | `rss` | - |
| 33 | `soundcloud` | soundcloud.com |
| 34 | `shutterstock` | shutterstock.com |
| 35 | `slack` | slack.com |
| 36 | `snapchat` | snapchat.com/add |
| 37 | `sourcerer` | sourcerer.io |
| 38 | `stackoverflow` | stackoverflow.com |
| 39 | `steam` | steampowered.com |
| 40 | `telegram` | telegram.org |
| 41 | `twitch` | twitch.tv |
| 42 | `twitter` | twitter.com |
| 43 | `youtube` | youtube.com |
| 44 | `other` | - |
| 17 | `gitea` | gitea.io |
| 18 | `hackerrank` | hackerrank.com |
| 19 | `hackthebox` | hackthebox.eu |
| 20 | `instagram` | instagram.com |
| 21 | `itchio` | itch.io |
| 22 | `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| 23 | `keybase` | keybase.io |
| 24 | `kofi` | ko-fi.com |
| 25 | `lastfm` | last.fm |
| 26 | `linkedin` | linkedin.com |
| 27 | `mastodon` | mastodon.social |
| 28 | `medium` | medium.com |
| 29 | `mixcloud` | mixcloud.com |
| 30 | `nuget` | nuget.org |
| 31 | `paypal` | paypal.com |
| 32 | `qq` | qq.com |
| 33 | `reddit` | reddit.com |
| 34 | `rss` | - |
| 35 | `soundcloud` | soundcloud.com |
| 36 | `shutterstock` | shutterstock.com |
| 37 | `slack` | slack.com |
| 38 | `snapchat` | snapchat.com/add |
| 39 | `sourcerer` | sourcerer.io |
| 40 | `stackoverflow` | stackoverflow.com |
| 41 | `steam` | steampowered.com |
| 42 | `telegram` | telegram.org |
| 43 | `twitch` | twitch.tv |
| 44 | `twitter` | twitter.com |
| 45 | `unsplash` | unsplash.com |
| 46 | `youtube` | youtube.com |
| 47 | `other` | - |
Usage :

22
content/posts/papermod/papermod-variables.md
View File

@ -15,18 +15,21 @@ weight: 5
### Site Variables under `Params`
| name | type | example | Description |
| -------------------------------------- | ------------- | ------------------------ | ----------------------------------------------------------------------------------- |
| -------------------------------------- | ------------- | ------------------------ | ----------------------------------------------------------------------------------------- |
| `env` | string | 'production' | To set env to production |
| `title` | string | 'My Blog' | To set title |
| `description` | string | 'This is a blog of mine' | To set site description |
| `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| `images` | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards |
| `DateFormat` | string | "January 2, 2006" | The format of date strings in the website. [Details](https://gohugo.io/functions/format/) |
| `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post |
| `defaultTheme` | string | light \| dark \| auto | To set default theme |
| `disableThemeToggle` | boolean | true \| false | To disable theme toggle icon shown besides label |
| `disableSpecial1stPost` | boolean | true \| false | To disable no-card special appearance of 1st post |
| `disableScrollToTop` | boolean | true \| false | To disable ScrollToTop button |
| `hidemeta` | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page |
| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages |
| `showtoc` | boolean | true \| false | To show/hide Table of Contents |
| `tocopen` | boolean | true \| false | To keep open ToC by default on page load |
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
@ -41,6 +44,7 @@ weight: 5
| `assets` | - | - | [Details](#assets) |
| `cover` | - | - | [Details](#cover) |
| `profileMode` | - | - | [Details](#profilemode) |
| `editPost` | - | - | [Details](#editPost) |
#### label
@ -117,12 +121,23 @@ socialIcons:
url: "<link2>"
```
#### editPost
```yml
editPost:
URL: "https://github.com/<path_to_repo>/content"
Text: "Suggest Changes" # edit text
appendFilePath: true # to append file path to Edit link
```
> Note: Same format is being used by Page Variables
---
### Page Variables
| Name | Type | Example | Description |
| ----------------- | ------------- | --------------------- | ----------------------------------------------------------------------------------- |
| ------------------ | ------------- | --------------------- | ----------------------------------------------------------------------------------- |
| `showtoc` | boolean | true \| false | To show/hide Table of Contents |
| `tocopen` | boolean | true \| false | To keep open ToC by default on page load |
| `hidemeta` | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page |
@ -131,7 +146,10 @@ socialIcons:
| `disableShare` | boolean | true \| false | To hide/show share icons under a page |
| `disableHLJS` | boolean | true \| false | To disable Highlight.js loading |
| `searchHidden` | boolean | true \| false | Hide page from search |
| `hideSummary` | boolean | true \| false | To Hide summary being shown in list pages |
| `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
| `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
| `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| `cover.image` | string | 'featured.jpg' | To add a cover image |
| `cover.caption ` | string | 'caption for image' | To add caption to cover image |