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

Aditya Telange 2021-02-07 14:51:35 +05:30
parent 8b18b49b88
commit dc4a347371
No known key found for this signature in database
GPG Key ID: 82E844EF3DA99E77
6 changed files with 175 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Features.md

@ -7,7 +7,7 @@
- [Regular Mode (default-mode)](#regular-mode-default-mode) - [Regular Mode (default-mode)](#regular-mode-default-mode)
- [Home-Info Mode](#home-info-mode) - [Home-Info Mode](#home-info-mode)
- [Profile Mode](#profile-mode) - [Profile Mode](#profile-mode)
- [Search](#search) - [Search Page](#search-page)
- [Draft Page indication](#draft-page-indication) - [Draft Page indication](#draft-page-indication)
- [Post Cover Image](#post-cover-image) - [Post Cover Image](#post-cover-image)
- [Share Buttons on post](#share-buttons-on-post) - [Share Buttons on post](#share-buttons-on-post)
@ -183,7 +183,7 @@ params:
--- ---
### Search ### Search Page
PaperMod uses [Fuse.js Basic](https://fusejs.io/getting-started/different-builds.html#explanation-of-different-builds) for seach functionality PaperMod uses [Fuse.js Basic](https://fusejs.io/getting-started/different-builds.html#explanation-of-different-builds) for seach functionality
@ -219,6 +219,12 @@ searchHidden: true
ex: [search.md](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/search.md) ex: [search.md](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/search.md)
> Search Page also has Key bindings:
>
> - Arrow keys to move up/down the list
> - Enter key (return) or Right Arrow key to Go to highlighted page
> - Escape key to clear searchbox and results
For Multilingual use `search.<lang>.md` ex. `search.es.md`. For Multilingual use `search.<lang>.md` ex. `search.es.md`.
**Note:** Search will work only on current language, user is currently on ! **Note:** Search will work only on current language, user is currently on !
@ -343,6 +349,8 @@ ShowBreadCrumbs: false
``` ```
---
### Other Posts suggestion below a post ### Other Posts suggestion below a post
Adds a Previous / Next post suggestion under a single post Adds a Previous / Next post suggestion under a single post
@ -352,6 +360,8 @@ params:
ShowPostNavLinks: true ShowPostNavLinks: true
``` ```
---
### Multiple Authors ### Multiple Authors
To Use multiple authors for a post, in post-variables: To Use multiple authors for a post, in post-variables:

4
Home.md

@ -1,6 +1,4 @@
# Welcome to the hugo-PaperMod wiki! # Welcome to the PaperMod's wiki!
## What is hugo-PaperMod ?
Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper). Hugo PaperMod is a theme based on [hugo-paper](https://github.com/nanxiaobei/hugo-paper).
The goal of this project is add more Features and customization to the og theme. The goal of this project is add more Features and customization to the og theme.

115
Icons.md

@ -6,59 +6,60 @@
## Social Icons ## Social Icons
| No. | Name | Platform Link | | No. | Name | Platform Link |
| --- | ------------- | ------------------------------- | | --- | --------------- | ------------------------------- |
| 1 | 123rf | 123rf.com | | 1 | `123rf` | 123rf.com |
| 2 | adobestock | stock.adobe.com | | 2 | `adobestock` | stock.adobe.com |
| 3 | behance | behance.net | | 3 | `behance` | behance.net |
| 4 | buymeacoffee | buymeacoffee.com | | 4 | `buymeacoffee` | buymeacoffee.com |
| 5 | codepen | codepen.io | | 5 | `codepen` | codepen.io |
| 6 | cryptohack | cryptohack.org | | 6 | `cryptohack` | cryptohack.org |
| 7 | dev | dev.to | | 7 | `dev` | dev.to |
| 8 | discogs | discogs.com | | 8 | `discogs` | discogs.com |
| 9 | discord | discord.com | | 9 | `discord` | discord.com |
| 10 | dreamstime | dreamstime.com | | 10 | `dreamstime` | dreamstime.com |
| 11 | dribbble | dribbble.com | | 11 | `dribbble` | dribbble.com |
| 12 | email | - | | 12 | `email` | - |
| 13 | facebook | facebook.com | | 13 | `facebook` | facebook.com |
| 14 | freepik | freepik.com | | 14 | `freepik` | freepik.com |
| 15 | github | github.com | | 15 | `github` | github.com |
| 16 | gitlab | gitlab.com | | 16 | `gitlab` | gitlab.com |
| 17 | hackerrank | hackerrank.com | | 17 | `hackerrank` | hackerrank.com |
| 18 | hackthebox | hackthebox.eu | | 18 | `hackthebox` | hackthebox.eu |
| 19 | instagram | instagram.com | | 19 | `instagram` | instagram.com |
| 20 | kakaotalk | kakaocorp.com/service/KakaoTalk | | 20 | `kakaotalk` | kakaocorp.com/service/KakaoTalk |
| 21 | keybase | keybase.io | | 21 | `keybase` | keybase.io |
| 22 | kofi | ko-fi.com | | 22 | `kofi` | ko-fi.com |
| 23 | lastfm | last.fm | | 23 | `lastfm` | last.fm |
| 24 | linkedin | linkedin.com | | 24 | `linkedin` | linkedin.com |
| 25 | mastodon | mastodon.social | | 25 | `mastodon` | mastodon.social |
| 26 | medium | medium.com | | 26 | `medium` | medium.com |
| 27 | mixcloud | mixcloud.com | | 27 | `mixcloud` | mixcloud.com |
| 28 | nuget | nuget.org | | 28 | `nuget` | nuget.org |
| 29 | paypal | paypal.com | | 29 | `paypal` | paypal.com |
| 30 | qq | qq.com | | 30 | `qq` | qq.com |
| 31 | reddit | reddit.com | | 31 | `reddit` | reddit.com |
| 32 | rss | - | | 32 | `rss` | - |
| 33 | soundcloud | soundcloud.com | | 33 | `soundcloud` | soundcloud.com |
| 34 | shutterstock | shutterstock.com | | 34 | `shutterstock` | shutterstock.com |
| 35 | slack | slack.com | | 35 | `slack` | slack.com |
| 36 | snapchat | snapchat.com/add | | 36 | `snapchat` | snapchat.com/add |
| 37 | sourcerer | sourcerer.io | | 37 | `sourcerer` | sourcerer.io |
| 38 | stackoverflow | stackoverflow.com | | 38 | `stackoverflow` | stackoverflow.com |
| 39 | steam | steampowered.com | | 39 | `steam` | steampowered.com |
| 40 | telegram | telegram.org | | 40 | `telegram` | telegram.org |
| 41 | twitch | twitch.tv | | 41 | `twitch` | twitch.tv |
| 42 | twitter | twitter.com | | 42 | `twitter` | twitter.com |
| 43 | youtube | youtube.com | | 43 | `youtube` | youtube.com |
| 44 | other | - | | 44 | `other` | - |
Usage : Usage :
``` ```
socialIcons: # optional socialIcons:
- name: "<NAME>" - name: "kofi"
url: "<link>" url: "https://kofi.com"
- name: "<NAME>" - name: "twitter"
url: "<link2>" url: "https://twitter.com"
``` ```
--- ---
@ -66,13 +67,13 @@ socialIcons: # optional
## Share Icons ## Share Icons
| No. | Platform | | No. | Platform |
| --- | -------- | | --- | --------------------------------------------------------------- |
| 1 | twitter | | 1 | `twitter` (also generates hash tags from tags linked with post) |
| 2 | linkedin | | 2 | `linkedin` |
| 3 | reddit | | 3 | `reddit` |
| 4 | facebook | | 4 | `facebook` |
| 5 | whatsapp | | 5 | `whatsapp` |
| 6 | telegram | | 6 | `telegram` |
Usage: Usage:

16
Installation.md

@ -8,9 +8,23 @@
- [Sample config.yml](#sample-configyml) - [Sample config.yml](#sample-configyml)
- [Sample Page.md](#sample-pagemd) - [Sample Page.md](#sample-pagemd)
---
## 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.
---
## Guide ## Guide
Follow [Quick Start](https://gohugo.io/getting-started/quick-start/) guide to setup hugo and create a new site. Follow [Quick Start](https://gohugo.io/getting-started/quick-start/) guide to setup hugo and create a new site.
> Note: Use -f to select yml format
>
> `hugo new site <name of site> -f yml`
Make sure you install latest version of **`hugo(>=0.74.0)`**. Make sure you install latest version of **`hugo(>=0.74.0)`**.
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: 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:
@ -38,7 +52,7 @@ you can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule
```bash ```bash
git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth=1 git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth=1
git submodule update --init --recursive git submodule update --init --recursive # needed when you reclone your repo (submodules may not get cloned automatically)
``` ```
**Note**: You may use ` --branch v4.0` to end of above command if you want to stick to specific release. **Note**: You may use ` --branch v4.0` to end of above command if you want to stick to specific release.

2
Translations.md

@ -19,6 +19,8 @@
## Want to add your Language ? ## Want to add your Language ?
Fork the theme, add `langcode.yaml` and submit a Pull Request.
Sample `langcode.yaml` Sample `langcode.yaml`
ISO codes can be found here: https://www.w3schools.com/tags/ref_language_codes.asp ISO codes can be found here: https://www.w3schools.com/tags/ref_language_codes.asp

158
Variables.md

@ -8,75 +8,87 @@
### Site Variables under `Params` ### Site Variables under `Params`
| name | type | example | Description | | name | type | example | Description |
| ------------------------------------ | ------------- | ------------------------ | ----------------------------------------------------------------------------------- | | -------------------------------------- | ------------- | ------------------------ | ----------------------------------------------------------------------------------- |
| env | string | 'production' | To set env to production | | `env` | string | 'production' | To set env to production |
| title | string | 'My Blog' | To set title | | `title` | string | 'My Blog' | To set title |
| description | string | 'This is a blog of mine' | To set site description | | `description` | string | 'This is a blog of mine' | To set site description |
| author | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors | | `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| images | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards | | `images` | string | 'myimage.png' | Link or path of image for opengraph, twitter-cards |
| ShowReadingTime | boolean | true \| false | To show read time in post meta | | `ShowReadingTime` | boolean | true \| false | To show read time in post meta |
| ShowShareButtons | boolean | true \| false | To show/hide share buttons under post | | `ShowShareButtons` | boolean | true \| false | To show/hide share buttons under post |
| defaultTheme | string | light \| dark \| auto | To set default theme | | `defaultTheme` | string | light \| dark \| auto | To set default theme |
| disableThemeToggle | boolean | true \| false | To disable theme toggle icon shown besides label | | `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 | | `disableSpecial1stPost` | boolean | true \| false | To disable no-card special appearance of 1st post |
| hidemeta | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page | | `hidemeta` | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page |
| showtoc | boolean | true \| false | To show/hide Table of Contents | | `showtoc` | boolean | true \| false | To show/hide Table of Contents |
| tocopen | boolean | true \| false | To keep open ToC by default on page load | | `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 | | `ShowPostNavLinks` | boolean | true \| false | Show Previous and Next Posts below a Post |
| ShowBreadCrumbs | boolean | true \| false | Show BreadCrumb Navigation above single post/page | | `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
| comments | boolean | true \| false | To show/hide comments | | `comments` | boolean | true \| false | To show/hide comments |
| analytics.google.SiteVerificationTag | string | "XYZabc" | Site Verification Tag for Google Analytics | | `analytics.google.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Google Analytics |
| analytics.bing.SiteVerificationTag | string | "XYZabc" | Site Verification Tag for Bing | | `analytics.bing.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Bing |
| analytics.yandex.SiteVerificationTag | string | "XYZabc" | Site Verification Tag for Yandex | | `analytics.yandex.SiteVerificationTag` | string | "XYZabc" | Site Verification Tag for Yandex |
| | | | | | `fuseOpts` | - | - | [Details](#fuseOpts) |
| fuseOpts | - | - | [Details](#fuseOpts) | | `socialIcons` | - | - | [Details](#socialIcons) |
| socialIcons | - | - | [Details](#socialIcons) | | `label` | - | - | [Details](#label) |
| label | - | - | [Details](#label) | | `assets` | - | - | [Details](#assets) |
| assets | - | - | [Details](#assets) | | `cover` | - | - | [Details](#cover) |
| cover | - | - | [Details](#cover) | | `profileMode` | - | - | [Details](#profilemode) |
| profileMode | - | - | [Details](#profilemode) |
#### label #### label
| name | type | example | Description | | name | type | example | Description |
| ---------------- | ------- | ----------------------- | ------------------------------------------------ | | ------------------ | ------- | ----------------------- | ------------------------------------------------ |
| label.text | string | 'Home' | To display different label text other than title | | `label.text` | string | 'Home' | To display different label text other than title |
| label.icon | string | '/apple-touch-icon.png' | To display a logo image in label | | `label.icon` | string | '/apple-touch-icon.png' | To display a logo image in label |
| label.iconHeight | integer | 35 | To set size of label logo image | | `label.iconHeight` | integer | 35 | To set size of label logo image |
#### profileMode #### profileMode
| name | type | example | Description | | name | type | example | Description |
| ----------------------- | ------- | ---------------------------------------------- | ---------------------------------------------------- | | ------------------------- | ------- | ---------------------------------------------- | ---------------------------------------------------- |
| profileMode.enabled | boolean | true \| false | For enabling profileMode, needs to be explicitly set | | `profileMode.enabled` | boolean | true \| false | For enabling profileMode, needs to be explicitly set |
| profileMode.title | string | "Title" | Title | | `profileMode.title` | string | "Title" | Title |
| profileMode.subtitle | string | "subtitle here" | Subtitle | | `profileMode.subtitle` | string | "subtitle here" | Subtitle |
| profileMode.imageUrl | string | "image.png" \| "https://example.com/image.jpg" | Image URL or Link | | `profileMode.imageUrl` | string | "image.png" \| "https://example.com/image.jpg" | Image URL or Link |
| profileMode.imageWidth | string | "150" | Width of image | | `profileMode.imageWidth ` | string | "150" | Width of image |
| profileMode.imageHeight | string | "150" | Height of image | | `profileMode.imageHeight` | string | "150" | Height of image |
| profileMode.imageTitle | string | "This image is a picture of .." | Title of image | | `profileMode.imageTitle` | string | "This image is a picture of .." | Title of image |
| profileMode.buttons | - | - | [Details](#profileModebuttons) | | `profileMode.buttons` | - | - | [Details](#profileModebuttons) |
##### profileMode.buttons
```yml
profileMode:
buttons:
- name: Archive
url: "/archive"
- name: Github
url: "https://github.com/"
```
#### assets #### assets
| name | type | example | Description | | name | type | example | Description |
| ---------------------------- | ------- | ---------- | -------------------------------------------- | | ------------------------------ | ------- | ------------- | -------------------------------------------- |
| assets.favicon | string | 'icon.ico' | To set favicon, can be path or external link | | `assets.favicon` | string | 'icon.ico' | To set favicon, can be path or external link |
| assets.disableHLJS | boolean | | | | `assets.disableHLJS` | boolean | true \| false | To disable Highlight.js loading |
| assets.disableFingerprinting | boolean | | | | `assets.disableFingerprinting` | boolean | true \| false | To disable Sub-Resource integrity for assets |
#### cover #### cover
| name | type | example | Description | | name | type | example | Description |
| ---------------------- | ------- | ------------- | ------------------------------------------------------- | | ------------------------ | ------- | ------------- | ------------------------------------------------------- |
| cover.linkFullImages | boolean | true \| false | To open full size cover images on click on cover | | `cover.linkFullImages` | boolean | true \| false | To open full size cover images on click on cover |
| cover.responsiveImages | boolean | true \| false | To enable/disable generation of responsive cover images | | `cover.responsiveImages` | boolean | true \| false | To enable/disable generation of responsive cover images |
| cover.hidden | boolean | true \| false | | | `cover.hidden` | boolean | true \| false | To hide everywhere but not in structured data |
| cover.hiddenInList | boolean | true \| false | | | `cover.hiddenInList` | boolean | true \| false | To hide on list pages and home |
| cover.hiddenInSingle | boolean | true \| false | | | `cover.hiddenInSingle ` | boolean | true \| false | To hide on list pages and home |
#### fuseOpts #### fuseOpts
Refer: https://fusejs.io/api/options.html
```yml ```yml
fuseOpts: fuseOpts:
isCaseSensitive: false isCaseSensitive: false
@ -98,37 +110,25 @@ socialIcons:
url: "<link2>" url: "<link2>"
``` ```
#### profileMode.buttons
```yml
profileMode:
buttons:
- name: Archive
url: "/archive"
- name: Github
url: "https://github.com/"
```
--- ---
### Page Variables ### Page Variables
| Name | Type | Example | Description | | Name | Type | Example | Description |
| --------------- | ------------- | --------------------- | ----------------------------------------------------------------------------------- | | ----------------- | ------------- | --------------------- | ----------------------------------------------------------------------------------- |
| showtoc | boolean | true \| false | To show/hide Table of Contents | | `showtoc` | boolean | true \| false | To show/hide Table of Contents |
| tocopen | boolean | true \| false | To keep open ToC by default on page load | | `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 | | `hidemeta` | boolean | true \| false | To Hide meta elements : date, read-time, author and available-translations for page |
| comments | boolean | true \| false | To show/hide comments | | `comments` | boolean | true \| false | To show/hide comments |
| description | string | 'description text' | Show Post Description under Title | | `description` | string | 'description text' | Show Post Description under Title |
| disableShare | boolean | true \| false | To hide/show share icons under a page | | `disableShare` | boolean | true \| false | To hide/show share icons under a page |
| disableHLJS | boolean | true \| false | | | `disableHLJS` | boolean | true \| false | To disable Highlight.js loading |
| searchHidden | boolean | true \| false | | | `searchHidden` | boolean | true \| false | Hide page from search |
| ShowBreadCrumbs | boolean | true \| false | Show BreadCrumb Navigation above single post/page | | `ShowBreadCrumbs` | boolean | true \| false | Show BreadCrumb Navigation above single post/page |
| author | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors | | `author` | string \|list | 'Me' \| ['Me','You'] | To show multiple Authors |
| cover.image | string | 'featured.jpg' | To add a cover image | | `cover.image` | string | 'featured.jpg' | To add a cover image |
| cover.caption | string | 'caption for image' | To add caption to cover image | | `cover.caption ` | string | 'caption for image' | To add caption to cover image |
| cover.alt | string | 'this is cover image' | Alternate text to show if image doesn't load/show up | | `cover.alt` | string | 'this is cover image' | Alternate text to show if image doesn't load/show up |
| cover.relative | boolean | true \| false | To use relative path for cover image, used in hugo Page-bundles | | `cover.relative` | boolean | true \| false | To use relative path for cover image, used in hugo Page-bundles |
| cover.hidden | boolean | true \| false | | | `cover.hidden ` | boolean | true \| false | To hide on current single page |
| | | | | | `weight ` | integer | 5 | To set page order or to pin a post to Top of list |
| weight | integer | 5 | To set page order or to pin a post to Top of list |