reorg exampleSite

exampleSite/content/docs/_index.md

@@ -0,0 +1,6 @@
+---
+title: PaperModX Docs
+summary: Contains documentations of PaperModX
+description: Contains documentations of PaperModX
+paginate: 10
+---

exampleSite/content/docs/emoji-support.md

@@ -1,9 +1,10 @@
 ---
-author: "Hugo Authors"
 title: "Emoji Support"
 date: "2019-03-05"
 description: "Guide to emoji usage in Hugo"
-tags: ["emoji"]
+author: "Hugo Authors"
+tags:
+  - example
 ShowToc: false
 ShowBreadCrumbs: false
 ---

exampleSite/content/docs/faq.md

@@ -2,12 +2,9 @@
 title: "FAQs"
 summary: Frequently Asked Questions
 date: 2021-01-20
-aliases: ["/papermod-how-to-guide"]
-tags: ["PaperMod"]
 author: "Aditya Telange"
 draft: true
-aliases: [/posts/papermod/papermod-how-to]
+weight: 4
-weight: 3
 ---
 
 ## Intro

exampleSite/content/docs/features/index.md

@@ -1,13 +1,13 @@
 ---
-title: "Features"
+title: "PaperMod Features"
-summary: Learn About All Features in PaperMod
+summary: Learn About All Features in original PaperMod
 date: 2021-01-20
-weight: 2
+weight: 3
-aliases: ["/papermod-features"]
-tags: ["PaperMod"]
 author: "Aditya Telange"
 ---
 
+> source: https://adityatelange.github.io/hugo-PaperMod/posts/papermod/papermod-features/
+
 ### 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.**
@@ -74,7 +74,7 @@ Create a page with `archive.md` in `content` directory with following content
 │   └── posts/
 ├── static/
 └── themes/
-    └── PaperMod/
+    └── PaperModX/
 ```
 
 and add the following to it
@@ -91,8 +91,6 @@ summary: archives
 
 **Note:** Archives Layout does not support Multilingual Month Translations.
 
-ex: [archives.md](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/archives.md)
-
 ---
 
 ### Regular Mode (default-mode)
@@ -122,13 +120,11 @@ params:
           url: "<link2>"
 ```
 
-ex. [config.yml#L106](https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/config.yml#L106)
-
 ---
 
 ### Profile Mode
 
-![profile](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/posts/papermod/papermod-features/images/profile.jpg)
+![profile](images/profile.jpg)
 
 Shows Index/Home page as Full Page with Social Links and Image
 
@@ -161,7 +157,7 @@ params:
 
 ### Search Page
 
-PaperMod uses [Fuse.js Basic](https://fusejs.io/getting-started/different-builds.html#explanation-of-different-builds) for seach functionality
+PaperModX uses [Fuse.js Basic](https://fusejs.io/getting-started/different-builds.html#explanation-of-different-builds) for seach functionality
 
 Add the following to site config, `config.yml`
 
@@ -193,8 +189,6 @@ To hide a particular page from being searched, add it in post's fron't matter
 searchHidden: true
 ```
 
-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

exampleSite/content/docs/icons.md

@@ -0,0 +1,42 @@
+---
+title: "Icons"
+summary: Explain how to use icons in PaperModX
+date: 2021-01-20
+weight: 4
+tags:
+  - icons
+---
+
+## Social Icons
+
+Go to [Icons Preview](icons_preview) to see a complete list of icons
+
+Usage :
+
+```
+socialIcons:
+    - name: "kofi"
+        url: "https://kofi.com"
+    - name: "twitter"
+        url: "https://twitter.com"
+```
+
+---
+
+## Share Icons
+
+| No. | Platform                                                        |
+| --- | --------------------------------------------------------------- |
+| 1   | `twitter` (also generates hash tags from tags linked with post) |
+| 2   | `linkedin`                                                      |
+| 3   | `reddit`                                                        |
+| 4   | `facebook`                                                      |
+| 5   | `whatsapp`                                                      |
+| 6   | `telegram`                                                      |
+
+Usage:
+
+```yml
+params:
+  ShowShareButtons: true
+```

exampleSite/content/docs/icons_preview.md

@@ -0,0 +1,9 @@
+---
+title: "Icons Preview"
+date: 2022-04-13
+summary: "Index of all icons in PaperModeX"
+layout: icons
+weight: 2
+tags:
+  - example
+---

exampleSite/content/docs/installation.md

@@ -2,10 +2,7 @@
 title: "Installation | Update"
 summary: Read Install and Update instructions here
 date: 2021-01-20
-series: ["PaperMod"]
+weight: 3
-weight: 1
-aliases: ["/papermod-installation"]
-tags: ["PaperMod"]
 author: "Aditya Telange"
 TocSide: left
 ---
@@ -34,7 +31,7 @@ After you have created a new site, at [Step 3](https://gohugo.io/getting-started
 Inside the folder of your Hugo site, run:
 
 ```bash
-git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1
+git clone https://github.com/reorx/hugo-PaperModX themes/PaperModX --depth=1
 ```
 
 **Note**: You may use ` --branch v5.0` to end of above command if you want to stick to specific release.
@@ -42,7 +39,7 @@ git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth
 > Updating theme :
 >
 > ```bash
-> cd themes/PaperMod
+> cd themes/PaperModX
 > git pull
 > ```
 
@@ -51,7 +48,7 @@ git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth
 You can use as [submodule](https://www.atlassian.com/git/tutorials/git-submodule) with
 
 ```bash
-git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth=1
+git submodule add https://github.com/reorx/hugo-PaperModX.git themes/PaperModX --depth=1
 git submodule update --init --recursive # needed when you reclone your repo (submodules may not get cloned automatically)
 ```
 
@@ -69,36 +66,36 @@ Or you can Download as Zip from Github Page and extract in your themes directory
 
 Direct Links:
 
--   [Master Branch (Latest)](https://github.com/adityatelange/hugo-PaperMod/archive/master.zip)
+-   [Master Branch (Latest)](https://github.com/reorx/hugo-PaperModX/archive/master.zip)
--   [v5.0](https://github.com/adityatelange/hugo-PaperMod/archive/v5.0.zip)
+-   [v5.0](https://github.com/reorx/hugo-PaperModX/archive/v5.0.zip)
--   [v4.0](https://github.com/adityatelange/hugo-PaperMod/archive/v4.0.zip)
+-   [v4.0](https://github.com/reorx/hugo-PaperModX/archive/v4.0.zip)
--   [v3.0](https://github.com/adityatelange/hugo-PaperMod/archive/v3.0.zip)
+-   [v3.0](https://github.com/reorx/hugo-PaperModX/archive/v3.0.zip)
--   [v2.0](https://github.com/adityatelange/hugo-PaperMod/archive/v2.0.zip)
+-   [v2.0](https://github.com/reorx/hugo-PaperModX/archive/v2.0.zip)
--   [v1.0](https://github.com/adityatelange/hugo-PaperMod/archive/v1.0.zip)
+-   [v1.0](https://github.com/reorx/hugo-PaperModX/archive/v1.0.zip)
 
 ### Finally ...
 
 Add in `config.yml`:
 
 ```yml
-theme: "PaperMod"
+theme: "PaperModX"
 ```
 ### Method 4
 
  - Install [Go programming language](https://go.dev/doc/install) in your operating system.
 
  - Intialize your own hugo mod
- 
+
 ```
 hugo mod init YOUR_OWN_GIT_REPOSITORY
 ```
 
- - Add PaperMod in your `config.yml` file
+ - Add PaperModX in your `config.yml` file
 
 ```
 module:
   imports:
-  - path: github.com/adityatelange/hugo-PaperMod
+  - path: github.com/reorx/hugo-PaperModX
 ```
  - Update theme
 
@@ -118,13 +115,13 @@ hugo mod get -u
 
 -   ### [Papermod - Icons](../papermod-icons)
 
--   ### [ChangeLog](https://github.com/adityatelange/hugo-PaperMod/releases)
+-   ### [ChangeLog](https://github.com/reorx/hugo-PaperModX/releases)
 
 ---
 
 ## Sample `config.yml`
 
-> **Example Site Structure is present here**: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/)
+> **Example Site Structure is present here**: [exampleSite](https://github.com/reorx/hugo-PaperModX/tree/exampleSite/)
 
 **Use appropriately**
 
@@ -132,7 +129,7 @@ hugo mod get -u
 baseURL: "https://examplesite.com/"
 title: ExampleSite
 paginate: 5
-theme: PaperMod
+theme: PaperModX
 
 enableRobotsTXT: true
 buildDrafts: false
@@ -150,7 +147,7 @@ params:
     env: production # to enable google analytics, opengraph, twitter-cards and schema.
     title: ExampleSite
     description: "ExampleSite description"
-    keywords: [Blog, Portfolio, PaperMod]
+    keywords: [Blog, Portfolio, PaperModX]
     author: Me
     # author: ["Me", "You"] # multiple authors
     images: ["<link or path of image for opengraph, twitter-cards>"]
@@ -255,7 +252,7 @@ menu:
           name: example.org
           url: https://example.org
           weight: 30
-# Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma
+# Read: https://github.com/reorx/hugo-PaperModX/wiki/FAQs#using-hugos-syntax-highlighter-chroma
 # pygmentsUseClasses: true
 # markup:
 #     highlight:

exampleSite/content/docs/math-typesetting.md

@@ -1,8 +1,12 @@
 ---
-author: Hugo Authors
 title: Math Typesetting
 date: 2019-03-08
+author: Hugo Authors
 description: A brief guide to setup KaTeX
+tags:
+  - math
+  - syntax
+  - example
 math: true
 ShowBreadCrumbs: false
 ---

exampleSite/content/docs/papermodx-new-features.md

@@ -6,7 +6,7 @@ weight: 1
 
 
 This page explains the new features and changes of PaperModX
-comparing to it's origin PaperMod.
+comparing to the original PaperMod.
 
 
 ## Table of Contents (ToC) floating on the side
@@ -19,11 +19,11 @@ params:
 ```
 
 ToC will float on the left/right side of the page.
-You can take a look at how `'right'` feels like in [Installation | Update](../papermod/papermod-installation).
+You can take a look at how `'right'` feels like in [Installation | Update](https://reorx.github.io/hugo-PaperModX/docs/installation/).
 
 The ToC box is responsive, it only shows on the side when minimum screen size is 1440px.
 
-this feature is enabled on this site.
+This feature is enabled on this site.
 
 
 ## InstantClick integration
@@ -50,6 +50,54 @@ so it has to give way to InstantCllick.
 This feature is enabled on this site.
 
 
+## Give links an accent color.
+
+Though PaperModX is designed to be minimal, accent color is still essential.
+It's a good way to show personality and make your site feels more delightful.
+
+The default color is a purple vibe,
+you can customize the colors of link, link underline and their hover variants
+by override the following css variables in `assets/css/extended/custom.css` of your site.
+
+```css
+:root {
+  --link-color: var(--primary);
+  --link-hover-color: #573eaa;
+  --link-underline-shadow: 0 1px 0 var(--link-color);
+  --link-hover-underline-color: #573eaa;
+  --link-hover-underline-shadow: 0 2px 0 var(--link-hover-underline-color);
+}
+```
+
+
+## Customize pagniator size
+
+In section pages, if you want the paginator size be different from the
+[global config](https://gohugo.io/templates/pagination/#configure-pagination),
+you can add `paginate` in the frontmatter to customize.
+
+```yaml
+---
+paginate: 10
+---
+```
+
+
+## Menus external link
+
+You can add `external: true` to a menu item's params to mark it as an external link,
+this will add a small icon to the end, and make the link open in new tab when clicked.
+
+```yaml
+menu:
+  main:
+    - name: "@Author"
+      url: "https://reorx.com"
+      params:
+        external: true
+```
+
+
 ## Social icons from Simple Icons
 
 Add social icons with `-simple` suffix from [Simple Icons](https://simpleicons.org/).
@@ -63,7 +111,8 @@ Available icons:
 
 The icons are moved from `layouts/partials/svg.html` to `data/svg.toml`,
 makes it easier to maintain, it's now possible to have an index page
-to show all the icons, check it out at: [Icons Preview](../../icons)
+to show all the icons, check it out at: [Icons Preview](https://reorx.github.io/hugo-PaperModX/docs/icons_preview/)
+
 
 ## Opinionated UI enhancements
 

exampleSite/content/docs/variables.md

@@ -1,8 +1,7 @@
 ---
 title: "Variables | Front Matter"
-summary: List of Front Matter variables used by PaperMod
+summary: List of Front Matter variables used by PaperModX
 date: 2021-01-20
-tags: ["PaperMod"]
 author: "Aditya Telange"
 draft: true
 weight: 5

exampleSite/content/icons.md

@@ -1,4 +0,0 @@
----
-title: "Icons Preview"
-layout: icons
----

exampleSite/content/posts/markdown-syntax.md

@@ -3,10 +3,10 @@ author: "Hugo Authors"
 title: "Markdown Syntax Guide"
 date: "2019-03-11"
 description: "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
-tags: ["markdown", "css", "html", "themes"]
+tags:
-categories: ["themes", "syntax"]
+  - markdown
-series: ["Themes Guide"]
+  - syntax
-aliases: ["migrate-from-jekyl"]
+  - example
 ShowToc: true
 TocOpen: true
 ---

exampleSite/content/posts/markdown-syntax.zh.md

@@ -3,9 +3,10 @@ author: "markdown.xyz"
 title: "Markdown 入门指南"
 date: "2022-04-12"
 description: "Markdown 概述、工作原理以及用途。"
-tags: ["markdown", "css", "html", "themes"]
+tags:
-categories: ["themes", "syntax"]
+  - markdown
-series: ["Themes Guide"]
+  - syntax
+  - example
 ShowToc: true
 TocOpen: true
 ---

exampleSite/content/posts/papermod/_index.md

@@ -1,5 +0,0 @@
----
-title: PaperMod
-summary: Contains posts related to `PaperMod`
-description: Contains posts related to PaperMod
----

exampleSite/content/posts/papermod/papermod-icons.md

@@ -1,101 +0,0 @@
----
-title: "Icons"
-summary: List of all Icons supported by PaperMod
-date: 2021-01-20
-weight: 4
-aliases: ["/papermod-icons"]
-tags: ["PaperMod"]
-author: "Aditya Telange"
-draft: true
----
-
-## Social Icons
-
-| No. | Name            | Platform Link                   |
-| --- | --------------- | ------------------------------- |
-| 1   | `123rf`         | 123rf.com                       |
-| 2   | `adobestock`    | stock.adobe.com                 |
-| 3   | `behance`       | behance.net                     |
-| 4   | `buymeacoffee`  | buymeacoffee.com                |
-| 5   | `codepen`       | codepen.io                      |
-| 6   | `cryptohack`    | cryptohack.org                  |
-| 7   | `ctftime`       | ctftime.org                     |
-| 8   | `dev`           | dev.to                          |
-| 9   | `discogs`       | discogs.com                     |
-| 10  | `discord`       | discord.com                     |
-| 11  | `dreamstime`    | dreamstime.com                  |
-| 12  | `dribbble`      | dribbble.com                    |
-| 13  | `email`         | -                               |
-| 14  | `facebook`      | facebook.com                    |
-| 15  | `flickr`        | flickr.com                      |
-| 16  | `freepik`       | freepik.com                     |
-| 17  | `gitea`         | gitea.io                        |
-| 18  | `github`        | github.com                      |
-| 19  | `gitlab`        | gitlab.com                      |
-| 20  | `goodreads`     | goodreads.com                   |
-| 21  | `hackerone`     | hackerone.com                   |
-| 22  | `hackerrank`    | hackerrank.com                  |
-| 23  | `hackthebox`    | hackthebox.eu                   |
-| 24  | `instagram`     | instagram.com                   |
-| 25  | `itchio`        | itch.io                         |
-| 26  | `kakaotalk`     | kakaocorp.com/service/KakaoTalk |
-| 27  | `keybase`       | keybase.io                      |
-| 28  | `kofi`          | ko-fi.com                       |
-| 29  | `lastfm`        | last.fm                         |
-| 30  | `liberapay`     | liberapay.com                   |
-| 31  | `linkedin`      | linkedin.com                    |
-| 32  | `mastodon`      | mastodon.social                 |
-| 33  | `matrix`        | matrix.org                      |
-| 34  | `medium`        | medium.com                      |
-| 35  | `mixcloud`      | mixcloud.com                    |
-| 36  | `nuget`         | nuget.org                       |
-| 37  | `paypal`        | paypal.com                      |
-| 38  | `qq`            | qq.com                          |
-| 39  | `reddit`        | reddit.com                      |
-| 40  | `rss`           | -                               |
-| 41  | `serverfault`   | serverfault.com                 |
-| 42  | `soundcloud`    | soundcloud.com                  |
-| 43  | `shutterstock`  | shutterstock.com                |
-| 44  | `slack`         | slack.com                       |
-| 45  | `snapchat`      | snapchat.com/add                |
-| 46  | `sourcerer`     | sourcerer.io                    |
-| 47  | `spotify`       | spotify.com                     |
-| 48  | `stackoverflow` | stackoverflow.com               |
-| 49  | `steam`         | steampowered.com                |
-| 50  | `telegram`      | telegram.org                    |
-| 51  | `twitch`        | twitch.tv                       |
-| 52  | `twitter`       | twitter.com                     |
-| 53  | `unsplash`      | unsplash.com                    |
-| 54  | `xda`           | xda-developers.com              |
-| 55  | `youtube`       | youtube.com                     |
-| 56  | `other`         | -                               |
-
-Usage :
-
-```
-socialIcons:
-    - name: "kofi"
-        url: "https://kofi.com"
-    - name: "twitter"
-        url: "https://twitter.com"
-```
-
----
-
-## Share Icons
-
-| No. | Platform                                                        |
-| --- | --------------------------------------------------------------- |
-| 1   | `twitter` (also generates hash tags from tags linked with post) |
-| 2   | `linkedin`                                                      |
-| 3   | `reddit`                                                        |
-| 4   | `facebook`                                                      |
-| 5   | `whatsapp`                                                      |
-| 6   | `telegram`                                                      |
-
-Usage:
-
-```yml
-params:
-  ShowShareButtons: true
-```

exampleSite/content/posts/placeholder-text.md

@@ -3,7 +3,8 @@ author: "Hugo Authors"
 title: "Placeholder Text"
 date: "2019-03-09"
 description: "Lorem Ipsum Dolor Si Amet"
-tags: ["markdown", "text"]
+tags:
+  - example
 hideMeta: true
 searchHidden: true
 ShowBreadCrumbs: false

exampleSite/content/posts/rich-content.md

@@ -3,7 +3,10 @@ author: "Hugo Authors"
 title: "Rich Content"
 date: "2019-03-10"
 description: "A brief description of Hugo Shortcodes"
-tags: ["shortcodes", "privacy"]
+tags:
+  - shortcodes
+  - privacy
+  - example
 ShowToc: true
 ---