diff --git a/content/posts/papermod/papermod-features.md b/content/posts/papermod/papermod-features.md new file mode 100644 index 00000000..1e22865d --- /dev/null +++ b/content/posts/papermod/papermod-features.md @@ -0,0 +1,173 @@ +--- +title: "Papermod - Features" +date: 2020-09-16T11:30:03+05:30 +showToc: true +hidemeta: true +TocOpen: true +weight: 2 +aliases: ['/papermod-features'] +tags: ['PaperMod'] +author: "Aditya Telange" +--- + +## Assets (js/css) +The following is enabled by default +- [minification](https://gohugo.io/hugo-pipes/minification/) - makes the assets size smallest as possible. +- [bundling](https://gohugo.io/hugo-pipes/bundling/) - bundles all the styles in one single asset +- [fingerprint/intergity](https://gohugo.io/hugo-pipes/fingerprint/) check. + +--- + +## Default Theme light/dark + +```yml +params: + defaultTheme: light +``` + +or + +```yml +params: + defaultTheme: dark +``` +--- + +## Archives Layout + +Add vars below to page-variables + +```yml +layout: "archives" +``` +ex: [here](https://raw.githubusercontent.com/adityatelange/hugo-PaperMod/exampleSite/content/archives.md) + +![](https://i.ibb.co/cNWc7GZ/paper-mod-archives.png) + +--- + +## Home-Info Mode + +Use 1st entry as some Information + +add following to config file +```yml +params: + homeInfoParams: + Title: Hi there wave + Content: Can be Info, links, about... + + socialIcons: # optional + - name: "" + url: "" + - name: "" + url: "" +``` + +ex. [here](https://github.com/adityatelange/hugo-PaperMod/blob/exampleSite/config.toml#L14) + +![](https://i.ibb.co/zsq6fLr/papermod-homeinfo.png) + +--- + +## Profile Mode + +Shows Index/Home page as Full Page with Social Links and Image + +add following to config file + +```yml +params: + profileMode: + enabled: true + title: "" # optional default will be site title + imageUrl: "<image link>" # optional + imageTitle: "<title of image as alt>" # optional + buttons: + - name: Archive + url: "/archive" + - name: Github + url: "https://github.com/" + + socialIcons: # optional + - name: "<platform>" + url: "<link>" + - name: "<platform 2>" + url: "<link2>" +``` + +![](https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png) + +--- + +## [Draft](https://gohugo.io/getting-started/usage/#draft-future-and-expired-content) Page indication + +adds `[draft]` mark to indicate draft pages. + +--- + +## Scroll-to-Top Button + Displays a Scroll-to-Top button in right-bottom corner + +--- + +## Share Buttons on post + +Displays Share Buttons at Bottom of each post + +to show share buttons add +```yml +params: + ShowShareButtons: true +``` + +![](https://i.ibb.co/sPN8bgd/paper-mod-share-butons.png) + +--- + +## Show post reading time + +Displays Reading Time (the estimated time, in minutes, it takes to read the content.) + +To show reading time add +```yml +Params: + ShowReadingTime: true +``` + +--- + +## Show Table of Contents on blog post + +Displays ToC on blog-pages + +To show ToC add following to page-variables +```yml +ShowToc: true +``` + +--- + +## Comments + +to add comments, create a html file + +`layouts/partials/comments.html` + +and paste code provided by your comments provider + +also in config add this +```yml +params: + comments: true +``` + +more : read [this](https://gohugo.io/content-management/comments/) + +--- + +### Scroll-Bar themed + +--- + +### Smooth Scroll between in-page links diff --git a/content/posts/papermod/papermod-icons.md b/content/posts/papermod/papermod-icons.md new file mode 100644 index 00000000..916fe144 --- /dev/null +++ b/content/posts/papermod/papermod-icons.md @@ -0,0 +1,78 @@ +--- +title: "Papermod - Icons" +date: 2020-09-17T11:30:03+05:30 +showToc: true +TocOpen: true +hidemeta: true +weight: 3 +aliases: ['/papermod-icons'] +tags: ['PaperMod'] +author: "Aditya Telange" +--- +Usage : + +``` +socialIcons: # optional + - name: "<NAME>" + url: "<link>" + - name: "<NAME>" + url: "<link2>" +``` + +| No. | name | platform link | +| --- | ------------- | ----------------- | +| 1 | 123rf | 123rf.com | +| 2 | adobestock | stock.adobe.com | +| 3 | behance | behance.net | +| 4 | codepen | codepen.io | +| 5 | cryptohack | cryptohack.org | +| 6 | dev | dev.to | +| 7 | discogs | discogs.com | +| 8 | dreamstime | dreamstime.com | +| 9 | dribbble | dribbble.com | +| 10 | email | - | +| 11 | facebook | facebook.com | +| 12 | freepik | freepik.com | +| 13 | github | github.com | +| 14 | gitlab | gitlab.com | +| 15 | hackerrank | hackerrank.com | +| 16 | hackthebox | hackthebox.eu | +| 17 | instagram | instagram.com | +| 18 | lastfm | last.fm | +| 19 | linkedin | linkedin.com | +| 20 | mixcloud | mixcloud.com | +| 21 | paypal | paypal.com | +| 22 | qq | qq.com | +| 23 | soundcloud | soundcloud.com | +| 24 | shutterstock | shutterstock.com | +| 25 | slack | slack.com | +| 26 | sourcerer | sourcerer.io | +| 27 | stackoverflow | stackoverflow.com | +| 28 | steam | steampowered.com | +| 29 | telegram | telegram.org | +| 30 | twitch | twitch.tv | +| 31 | twitter | twitter.com | +| 32 | youtube | youtube.com | +| | other | - | + +--- + +# Share Icons + +| No. | Platform | +| --- | -------- | +| 1 | facebook | +| 2 | linkedin | +| 3 | reddit | +| 4 | telegram | +| 5 | twitter | +| 6 | whatsapp | + +Usage: + +```yml +params: + ShowShareButtons: true +``` + +![](https://i.ibb.co/sPN8bgd/paper-mod-share-butons.png) diff --git a/content/posts/papermod/papermod-installation.md b/content/posts/papermod/papermod-installation.md new file mode 100644 index 00000000..7b347dfd --- /dev/null +++ b/content/posts/papermod/papermod-installation.md @@ -0,0 +1,53 @@ +--- +title: "Papermod - Installation" +date: 2020-09-15T11:30:03+05:30 +series: ["PaperMod"] +weight: 1 +hidemeta: true +showToc: true +TocOpen: true +aliases: ['/papermod-installation'] +tags: ['PaperMod'] +author: "Aditya Telange" +--- + +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 +> ``` +> > Updating theme with submodule : +> > ```console +> > git submodule update --remote --merge +> > ``` +> > +Then change in `config.toml`: +> +```yml +theme: "hugo-PaperMod" +``` + +Example Site Structure is present here: [exampleSite](https://github.com/adityatelange/hugo-PaperMod/tree/exampleSite/) + +--- + +### [Papermod - Features](/papermod-features) +### [Papermod - How to Guide](/papermod-how-to-guide) +### [Papermod - Icons](/papermod-icons) \ No newline at end of file