This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme. Headings The following HTML — elements represent six levels of section headings. is the highest section level while is the lowest. H1 H2 H3 H4 H5 H6 Paragraph Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat. Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. Blockquotes The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations. Blockquote without attribution Tiam, ad mint andaepu dandae nostion secatur sequo quae. Note that you can use Markdown syntax within a blockquote. Blockquote with attribution Don’t communicate by sharing memory, share memory by communicating.— Rob Pike1 Tables Tables aren’t part of the core Markdown spec, but Hugo supports supports them out-of-the-box. Name Age Bob 27 Alice 23 Inline Markdown within tables Italics Bold Code italics bold code Code Blocks Code block with backticks html lang="en" head meta charset="utf-8" / titleExample HTML5 Documenttitle head body pTestp body html Code block indented with four spaces Example HTML5 Document Test Code block with Hugo’s internal highlight shortcode html lang="en" head meta charset="utf-8" titleExample HTML5 Documenttitle head body pTestp body html List Types Ordered List First item Second item Third item Unordered List List item Another item And another item Nested list Fruit Apple Orange Banana Dairy Milk Cheese Other Elements — abbr, sub, sup, kbd, mark GIFis a bitmap image format. H2O Xn+ Yn: ZnPress CTRL+ALT+Deleteto end the session. Most salamandersare nocturnal, and hunt for insects, worms, and other small creatures. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩︎
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme. Headings The following HTML — elements represent six levels of section headings. is the highest section level while is the lowest. H1 H2 H3 H4 H5 H6 Paragraph Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat. Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. Blockquotes The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations. Blockquote without attribution Tiam, ad mint andaepu dandae nostion secatur sequo quae. Note that you can use Markdown syntax within a blockquote. Blockquote with attribution Don’t communicate by sharing memory, share memory by communicating.— Rob Pike1 Tables Tables aren’t part of the core Markdown spec, but Hugo supports supports them out-of-the-box. Name Age Bob 27 Alice 23 Inline Markdown within tables Italics Bold Code italics bold code Code Blocks Code block with backticks html lang="en" head meta charset="utf-8" / titleExample HTML5 Documenttitle head body pTestp body html Code block indented with four spaces Example HTML5 Document Test Code block with Hugo’s internal highlight shortcode html lang="en" head meta charset="utf-8" titleExample HTML5 Documenttitle head body pTestp body html List Types Ordered List First item Second item Third item Unordered List List item Another item And another item Nested list Fruit Apple Orange Banana Dairy Milk Cheese Other Elements — abbr, sub, sup, kbd, mark GIFis a bitmap image format. H2O Xn+ Yn= ZnPress CTRL+ALT+Deleteto end the session. Most salamandersare nocturnal, and hunt for insects, worms, and other small creatures. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩︎
Emoji can be enabled in a Hugo project in a number of ways. The emojify function can be called directly in templates or Inline Shortcodes. To enable emoji globally, set enableEmoji to true in your site’s configuration and then you can type emoji shorthand codes directly in content files; e.g. The Emoji cheat sheet is a useful reference for emoji shorthand codes. N.B. The above steps enable Unicode Standard emoji characters and sequences in Hugo, however the rendering of these glyphs depends on the browser and the platform. To style the emoji you can either use a third party emoji font or a font stack; e.g. .emoji { font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols; } .emojify { font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols; font-size: 2rem; vertical-align: middle; } @media screen and (max-width:650px) { .nowrap { display: block; margin: 25px 0; } }
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme. Headings The following HTML — elements represent six levels of section headings. is the highest section level while is the lowest. H1 H2 H3 H4 H5 H6 Paragraph Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat. Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. Blockquotes The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations. Blockquote without attribution Tiam, ad mint andaepu dandae nostion secatur sequo quae. Note that you can use Markdown syntax within a blockquote. Blockquote with attribution Don’t communicate by sharing memory, share memory by communicating.— Rob Pike1 Tables Tables aren’t part of the core Markdown spec, but Hugo supports supports them out-of-the-box. Name Age Bob 27 Alice 23 Inline Markdown within tables Italics Bold Code italics bold code Code Blocks Code block with backticks html lang="en" head meta charset="utf-8" / titleExample HTML5 Documenttitle head body pTestp body html Code block indented with four spaces Example HTML5 Document Test Code block with Hugo’s internal highlight shortcode html lang="en" head meta charset="utf-8" titleExample HTML5 Documenttitle head body pTestp body html List Types Ordered List First item Second item Third item Unordered List List item Another item And another item Nested list Fruit Apple Orange Banana Dairy Milk Cheese Other Elements — abbr, sub, sup, kbd, mark GIFis a bitmap image format. H2O Xn+ Yn= ZnPress CTRL+ALT+Deleteto end the session. Most salamandersare nocturnal, and hunt for insects, worms, and other small creatures. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩︎
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme. Headings The following HTML — elements represent six levels of section headings. is the highest section level while is the lowest. H1 H2 H3 H4 H5 H6 Paragraph Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat. Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat. Blockquotes The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations. Blockquote without attribution Tiam, ad mint andaepu dandae nostion secatur sequo quae. Note that you can use Markdown syntax within a blockquote. Blockquote with attribution Don’t communicate by sharing memory, share memory by communicating. — Rob Pike1 Tables Tables aren’t part of the core Markdown spec, but Hugo supports supports them out-of-the-box. Name Age Bob 27 Alice 23 Inline Markdown within tables Italics Bold Code italics bold code Code Blocks Code block with backticks html lang="en" head meta charset="utf-8" / titleExample HTML5 Documenttitle head body pTestp body html Code block indented with four spaces Example HTML5 Document Test Code block with Hugo’s internal highlight shortcode html lang="en" head meta charset="utf-8" titleExample HTML5 Documenttitle head body pTestp body html List Types Ordered List First item Second item Third item Unordered List List item Another item And another item Nested list Fruit Apple Orange Banana Dairy Milk Cheese Other Elements — abbr, sub, sup, kbd, mark GIFis a bitmap image format. H2O Xn+ Yn= ZnPress CTRL+ALT+Deleteto end the session. Most salamandersare nocturnal, and hunt for insects, worms, and other small creatures. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015. ↩︎
Mathematical notation in a Hugo project can be enabled by using third party JavaScript libraries. In this example we will be using KaTeX Create a partial under /layouts/partials/math.html Within this partial reference the Auto-render Extension or host these scripts locally. Include the partial in your templates like so: {{ if or .Params.math .Site.Params.math }} {{ partial "math.html" . }} {{ end }} To enable KaTex globally set the parameter math to true in a project’s configuration To enable KaTex on a per page basis include the parameter math: true in content files Note: Use the online reference of Supported TeX Functions Examples Inline math: \(\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…\) Block math: $$ \varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } } $$
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 converters if necessary. Override theme template By Hugo’s Lookup Order, you can override any part of a theme that you want. The following is a quick example. Let’s say you wish the list was different. All you have to do is copy the list template: your-site/themes/papermod/layouts/_defaults/list.html And paste it under your own layouts folder: your-site/layouts/_defaults/list.html Then you’re free to make any changes you want to the list. When Hugo builds your site, your copy of list.html will be used instead of the theme’s list.html. Enable Social-Metadata and SEO These include OpenGraph, Twitter Cards and Schema. params: env: production or set HUGO_ENV as “production” in system env-vars Failed to find a valid digest in the ‘integrity’ attribute for resource … ? Read about How Subresource Integrity helps: Subresource_Integrity Why was the asset not loading ? : How_browsers_handle_Subresource_Integrity Solution: Set the following in config.yml params: assets: disableFingerprinting: true Linked Issues: https://stackoverflow.com/questions/65056585/hugo-theme-not-loading https://stackoverflow.com/questions/65040931/hugo-failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource https://blog.gerardbeckerleg.com/posts/hugo-failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource/ Archive Page . ├── config.yml ├── content/ │ ├── archives.md and add the following to it --- title: "Archive" layout: "archives" url: "/archives/" summary: archives --- Bundling Custom css with theme’s assets For adding custom css to be bundled inside one minimized css Create folder in yout project directory as .(site root) ├── config.yml ├── content/ ├── theme/hugo-PaperMod/ └── assets/ └── css/ └── extended/ All css files inside assets/css/extended will be bundled ! Note: blank.css is just the placeholder so that it doesn’t break the theme when no files are present under assets/css/extended Linked Issues: Papermod Theme: How to add custom CSS? Custom Head / Footer Custom css/js can be added by way mentioned below. .(site root) ├── config.yml ├── content/ ├── theme/hugo-PaperMod/ └── layouts ├── partials │ ├── comments.html │ ├── extend_footer.html Create a html page in directory structure as shown above. Contents of extend_head.html will be added to head of page. and contents of extend_footer.html will be added to bottom of page. Add menu to site 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: menu: main: - identifier: categories name: categories url: /categories/ weight: 10 - identifier: tags name: tags url: /tags/ weight: 20 - identifier: example name: example.org url: https://example.org weight: 30 name controls what will be displayed for the menu entry. url sets the URL that the entry points to. weight is used to control the positioning of entries. For more information on menus, see the Hugo wiki page. Pin a Post Post can be pinned/ displayed top on the list by adding a weight= var to page-variables example: --- title: "My Important post" date: 2020-09-15T11:30:03+00:00 weight: 1 --- --- title: "My 2nd Important post" date: 2020-09-15T11:30:03+00:00 weight: 2 --- Adding Custom Favicon(s) We support the following paths under /static directory and can be added accordingly. favicon.ico favicon-16x16.png favicon-32x32.png apple-touch-icon.png safari-pinned-tab.svg site.webmanifest Favicon(s) can be generated by Favicon.io and can be simply put in /static folder. Other way is to add favicon(s) NOT located in /static folder. In site config add the following: params: assets: favicon: "" favicon16x16: "" favicon32x32: "" apple_touch_icon: "" safari_pinned_tab: "" absolute url means direct links to external resource: ex. https://web.site/someimage.png example: 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" References Override a Hugo theme
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 converters if necessary. Override theme template By Hugo’s Lookup Order, you can override any part of a theme that you want. The following is a quick example. Let’s say you wish the list was different. All you have to do is copy the list template: your-site/themes/papermod/layouts/_defaults/list.html And paste it under your own layouts folder: your-site/layouts/_defaults/list.html Then you’re free to make any changes you want to the list. When Hugo builds your site, your copy of list.html will be used instead of the theme’s list.html. Enable Social-Metadata and SEO These include OpenGraph, Twitter Cards and Schema. params: env: production or set HUGO_ENV as “production” in system env-vars Failed to find a valid digest in the ‘integrity’ attribute for resource … ? Read about How Subresource Integrity helps: Subresource_Integrity Why was the asset not loading ? : How_browsers_handle_Subresource_Integrity Solution: Set the following in config.yml params: assets: disableFingerprinting: true Linked Issues: https://stackoverflow.com/questions/65056585/hugo-theme-not-loading https://stackoverflow.com/questions/65040931/hugo-failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource https://blog.gerardbeckerleg.com/posts/hugo-failed-to-find-a-valid-digest-in-the-integrity-attribute-for-resource/ Archive Page . ├── config.yml ├── content/ │ ├── archives.md and add the following to it --- title: "Archive" layout: "archives" url: "/archives/" summary: archives --- Bundling Custom css with theme’s assets For adding custom css to be bundled inside one minimized css Create folder in yout project directory as .(site root) ├── config.yml ├── content/ ├── theme/hugo-PaperMod/ └── assets/ └── css/ └── extended/ All css files inside assets/css/extended will be bundled ! Note: blank.css is just the placeholder so that it doesn’t break the theme when no files are present under assets/css/extended Linked Issues: Papermod Theme: How to add custom CSS? Custom Head / Footer Custom css/js can be added by way mentioned below. .(site root) ├── config.yml ├── content/ ├── theme/hugo-PaperMod/ └── layouts ├── partials │ ├── comments.html │ ├── extend_footer.html Create a html page in directory structure as shown above. Contents of extend_head.html will be added to head of page. and contents of extend_footer.html will be added to bottom of page. Add menu to site 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: menu: main: - identifier: categories name: categories url: /categories/ weight: 10 - identifier: tags name: tags url: /tags/ weight: 20 - identifier: example name: example.org url: https://example.org weight: 30 name controls what will be displayed for the menu entry. url sets the URL that the entry points to. weight is used to control the positioning of entries. For more information on menus, see the Hugo wiki page. Pin a Post Post can be pinned/ displayed top on the list by adding a weight= var to page-variables example: --- title: "My Important post" date: 2020-09-15T11:30:03+00:00 weight: 1 --- --- title: "My 2nd Important post" date: 2020-09-15T11:30:03+00:00 weight: 2 --- Adding Custom Favicon(s) We support the following paths under /static directory and can be added accordingly. favicon.ico favicon-16x16.png favicon-32x32.png apple-touch-icon.png safari-pinned-tab.svg site.webmanifest Favicon(s) can be generated by Favicon.io and can be simply put in /static folder. Other way is to add favicon(s) NOT located in /static folder. In site config add the following: params: assets: favicon: "" favicon16x16: "" favicon32x32: "" apple_touch_icon: "" safari_pinned_tab: "" absolute url means direct links to external resource: ex. https://web.site/someimage.png example: 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" Centering image in markdown Add #center after image to center align an image  Thanks to @pacientes for this References Override a Hugo theme
Assets (js/css) The following is enabled by default minification - makes the assets size smallest as possible. bundling - bundles all the styles in one single asset fingerprint/intergity check. Default Theme light/dark/auto params: # defaultTheme: light # defaultTheme: dark defaultTheme: auto # to switch between dark or light according to browser theme Theme Switch Toggle (enabled by default) Shows icon besides title of page to change theme To disable it : disableThemeToggle: true You can refer following table for better understanding… defaultTheme disableThemeToggle checks local storage? checks system theme? Info auto true No Yes only system theme false Yes (if not-2) Yes (2) switch present dark true No No force dark only false Yes No switch present light true No No force light only false Yes No switch present Archives Layout Create a page with archive.md in content directory with following content --- title: "Archive" # in any language you want layout: "archives" # is necessary url: "/archive" summary: "archive" --- Note: Archives Layout does not support Multilingual Month Translations. ex: archives.md Regular Mode (default-mode) Home-Info Mode Use 1st entry as some Information add following to config file params: homeInfoParams: Title: Hi there wave Content: Can be Info, links, about... socialIcons: # optional - name: "" url: "" - name: "" url: "" ex. here Profile Mode Shows Index/Home page as Full Page with Social Links and Image add following to config file params: profileMode: enabled: true title: "" # optional default will be site title imageUrl: "" # optional imageTitle: "" # optional imageWidth: 120 # custom size imageHeight: 120 # custom size buttons: - name: Archive url: "/archive" - name: Github url: "https://github.com/" socialIcons: # optional - name: "" url: "" - name: "" url: "" Search Add the following to site config, config.yml outputs: home: - HTML - RSS - JSON # is necessary Create a page with search.md in content directory with following content --- title: "Search" # in any language you want layout: "search" # is necessary # url: "/archive" summary: "search" --- For Multilingual use search..md ex. search.es.md. Note: Search will work only on current language, user is currently on ! Customizing Fusejs Options Refer https://fusejs.io/api/options.html for Options, Add those as shown below. params: fuseOpts: isCaseSensitive: false shouldSort: true location: 0 distance: 1000 threshold: 0.4 minMatchCharLength: 0 keys: ["title", "permalink", "summary", "content"] ex: search.md Draft Page indication adds [draft] mark to indicate draft pages. Post Cover Image In post’s page-variables add : cover: image: "" # can also paste direct link from external site # ex. https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png alt: "" caption: "" When you include images in the Page Bundle, multiple sizes of the image will automatically be provided using the HTML5 srcset field. To reduce generation time and size of the site, you can disable this feature using params: cover: responsiveImages: false To enable hyperlinks to the full image size on post pages, use params: cover: linkFullImages: true Share Buttons on post Displays Share Buttons at Bottom of each post to show share buttons add params: ShowShareButtons: true Show post reading time Displays Reading Time (the estimated time, in minutes, it takes to read the content.) To show reading time add Params: ShowReadingTime: true Show Table of Contents (Toc) on blog post Displays ToC on blog-pages To show ToC add following to page-variables ShowToc: true To keep Toc Open by default on a post add following to page-variables: TocOpen: true Multiple Authors To Use multiple authors for a post, in post-variables: --- author: ["Me", "You"] --- To use Multiple Authors Site-wide, in config.yml: params: author: ["Me", "You"] 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 params: comments: true read more about this here Misc Scroll-Bar themed (by default) Smooth Scroll between in-page links (by default) Scroll-to-Top Button (by default) Displays a Scroll-to-Top button in right-bottom corner Google Analytics integration Open-Graph support Twitter Cards Support Syntax highlighting Twitter cards and opengraph tags support RSS feeds Multilingual Support
Assets (js/css) The following is enabled by default minification - makes the assets size smallest as possible. bundling - bundles all the styles in one single asset fingerprint/intergity check. Default Theme light/dark/auto params: # defaultTheme: light # defaultTheme: dark defaultTheme: auto # to switch between dark or light according to browser theme Theme Switch Toggle (enabled by default) Shows icon besides title of page to change theme To disable it : disableThemeToggle: true You can refer following table for better understanding… defaultTheme disableThemeToggle checks local storage? checks system theme? Info auto true No Yes only system theme false Yes (if not-2) Yes (2) switch present dark true No No force dark only false Yes No switch present light true No No force light only false Yes No switch present Archives Layout Create a page with archive.md in content directory with following content --- title: "Archive" # in any language you want layout: "archives" # is necessary url: "/archive" summary: "archive" --- Note: Archives Layout does not support Multilingual Month Translations. ex: archives.md Regular Mode (default-mode) Home-Info Mode Use 1st entry as some Information add following to config file params: homeInfoParams: Title: Hi there wave Content: Can be Info, links, about... socialIcons: # optional - name: "" url: "" - name: "" url: "" ex. here Profile Mode Shows Index/Home page as Full Page with Social Links and Image add following to config file params: profileMode: enabled: true title: "" # optional default will be site title imageUrl: "" # optional imageTitle: "" # optional imageWidth: 120 # custom size imageHeight: 120 # custom size buttons: - name: Archive url: "/archive" - name: Github url: "https://github.com/" socialIcons: # optional - name: "" url: "" - name: "" url: "" Search Add the following to site config, config.yml outputs: home: - HTML - RSS - JSON # is necessary Create a page with search.md in content directory with following content --- title: "Search" # in any language you want layout: "search" # is necessary # url: "/archive" summary: "search" --- For Multilingual use search..md ex. search.es.md. Note: Search will work only on current language, user is currently on ! Customizing Fusejs Options Refer https://fusejs.io/api/options.html for Options, Add those as shown below. params: fuseOpts: isCaseSensitive: false shouldSort: true location: 0 distance: 1000 threshold: 0.4 minMatchCharLength: 0 keys: ["title", "permalink", "summary", "content"] ex: search.md Draft Page indication adds [draft] mark to indicate draft pages. Post Cover Image In post’s page-variables add : cover: image: "" # can also paste direct link from external site # ex. https://i.ibb.co/K0HVPBd/paper-mod-profilemode.png alt: "" caption: "" When you include images in the Page Bundle, multiple sizes of the image will automatically be provided using the HTML5 srcset field. To reduce generation time and size of the site, you can disable this feature using params: cover: responsiveImages: false To enable hyperlinks to the full image size on post pages, use params: cover: linkFullImages: true Share Buttons on post Displays Share Buttons at Bottom of each post to show share buttons add params: ShowShareButtons: true Show post reading time Displays Reading Time (the estimated time, in minutes, it takes to read the content.) To show reading time add Params: ShowReadingTime: true Show Table of Contents (Toc) on blog post Displays ToC on blog-pages To show ToC add following to page-variables ShowToc: true To keep Toc Open by default on a post add following to page-variables: TocOpen: true Multiple Authors To Use multiple authors for a post, in post-variables: --- author: ["Me", "You"] --- To use Multiple Authors Site-wide, in config.yml: params: author: ["Me", "You"] 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 params: comments: true read more about this here AccessKeys c - ToC Open/Close g - Go To Top h - Home (according to current lang) t - Theme toggle / - Jumps to search page if in menu What’s AccessKeys ? Enhanced SEO Enabled only when env: prod Rich Results/Snippets Support Twitter Cards Support Open-Graph support Multilingual Support Misc Scroll-Bar themed (by default) Smooth Scroll between in-page links (by default) Scroll-to-Top Button (by default) Displays a Scroll-to-Top button in right-bottom corner Google Analytics integration Syntax highlighting RSS feeds
Social Icons Usage : socialIcons: # optional - name: "" url: "" - name: "" url: "" 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 dev dev.to 8 discogs discogs.com 9 discord discord.com 10 dreamstime dreamstime.com 11 dribbble dribbble.com 12 email - 13 facebook facebook.com 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 paypal paypal.com 29 qq qq.com 30 rss - 31 soundcloud soundcloud.com 32 shutterstock shutterstock.com 33 slack slack.com 34 sourcerer sourcerer.io 35 stackoverflow stackoverflow.com 36 steam steampowered.com 37 telegram telegram.org 38 twitch twitch.tv 39 twitter twitter.com 40 youtube youtube.com 41 other - Share Icons No. Platform 1 twitter 2 linkedin 3 reddit 4 facebook 5 whatsapp 6 telegram Usage: params: ShowShareButtons: true You can see Below how share Icons Look.
Social Icons Usage : socialIcons: # optional - name: "" url: "" - name: "" url: "" 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 dev dev.to 8 discogs discogs.com 9 discord discord.com 10 dreamstime dreamstime.com 11 dribbble dribbble.com 12 email - 13 facebook facebook.com 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 paypal paypal.com 29 qq qq.com 30 rss - 31 soundcloud soundcloud.com 32 shutterstock shutterstock.com 33 slack slack.com 34 sourcerer sourcerer.io 35 stackoverflow stackoverflow.com 36 steam steampowered.com 37 telegram telegram.org 38 twitch twitch.tv 39 twitter twitter.com 40 youtube youtube.com 41 other - Share Icons No. Platform 1 twitter 2 linkedin 3 reddit 4 facebook 5 whatsapp 6 telegram Usage: params: ShowShareButtons: true You can see Below how share Icons Look.
Guide Follow this guide to setup hugo and create a new site. Make sure you install latest version of hugo(=0.74.0). After you have created a new site, at Step 3 follow the steps: Inside the folder of your Hugo site, run: git clone https://github.com/adityatelange/hugo-PaperMod themes/hugo-PaperMod --depth=1 Updating theme : cd themes/hugo-PaperMod git pull or you can use as submodule with git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/hugo-PaperMod git submodule update --init --recursive Updating theme with submodule : git submodule update --remote --merge Then change in config.yml: theme: "hugo-PaperMod" Example Site Structure is present here: exampleSite Sample config.yml baseURL: "https://examplesite.com" title: ExampleSite paginate: 5 theme: hugo-PaperMod enableRobotsTXT: true buildDrafts: false buildFuture: false buildExpired: false googleAnalytics: UA-123-45 minify: disableXML: true minifyOutput: true params: env: production # to enable google analytics, opengraph, twitter-cards and schema. title: ExampleSite description: "ExampleSite description" author: Me # author: ["Me", "You"] # multiple authors images: [""] ShowReadingTime: true ShowShareButtons: true comments: false defaultTheme: auto disableThemeToggle: false disableSpecial1stPost: false assets: favicon: "" favicon16x16: "" favicon32x32: "" apple_touch_icon: "" safari_pinned_tab: "" label: text: "Home" icon: /apple-touch-icon.png iconHeight: 35 # profile-mode profileMode: enabled: false # needs to be explicitly set title: ExampleSite # imageUrl: '' # imageTitle: my image buttons: - name: Posts url: posts - name: Tags url: tags # home-info mode homeInfoParams: Title: "Hi there \U0001F44B" Content: Welcome to my blog socialIcons: - name: twitter url: "https://twitter.com/" - name: stackoverflow url: "https://stackoverflow.com" - name: github url: "https://github.com/" analytics: google: SiteVerificationTag: "XYZabc" menu: main: - identifier: categories name: categories url: /categories/ weight: 10 - identifier: tags name: tags url: /tags/ weight: 20 - identifier: example name: example.org url: https://example.org weight: 30 Sample Page.md --- title: "My 1st post" date: 2020-09-15T11:30:03+00:00 weight: 1 aliases: ["/first"] tags: ["first"] author: "Me" # author: ["Me", "You"] # multiple authors showToc: true TocOpen: false draft: false hidemeta: false disableShare: false cover: image: "" alt: "" caption: "" relative: false comments: false --- Papermod - Features Papermod - How to Guide Papermod - Icons
Guide Follow Quick Start guide to setup hugo and create a new site. Make sure you install latest version of hugo(=0.74.0). After you have created a new site, at Step 3 follow the steps: Method 1 Inside the folder of your Hugo site, run: git clone https://github.com/adityatelange/hugo-PaperMod themes/PaperMod --depth=1 Note: You may use --branch v3.0 to end of above command if you want to stick to specific release. Updating theme : cd themes/PaperMod git pull Method 2 you can use as submodule with git submodule add https://github.com/adityatelange/hugo-PaperMod.git themes/PaperMod --depth=1 git submodule update --init --recursive Note: You may use --branch v3.0 to end of above command if you want to stick to specific release. Updating theme : git submodule update --remote --merge Then change in config.yml: theme: "PaperMod" Method 3 Or you can Download as Zip from Github Page and extract in your themes directory Quick Links Papermod - Features Papermod - How to Guide Papermod - Icons ChangeLog Sample config.yml Example Site Structure is present here: exampleSite Use appropriately baseURL: "https://examplesite.com" title: ExampleSite paginate: 5 theme: hugo-PaperMod enableRobotsTXT: true buildDrafts: false buildFuture: false buildExpired: false googleAnalytics: UA-123-45 minify: disableXML: true minifyOutput: true params: env: production # to enable google analytics, opengraph, twitter-cards and schema. title: ExampleSite description: "ExampleSite description" author: Me # author: ["Me", "You"] # multiple authors images: [""] ShowReadingTime: true ShowShareButtons: true comments: false defaultTheme: auto disableThemeToggle: false disableSpecial1stPost: false assets: # disableHLJS: true # to disable highlightjs # disableFingerprinting: true favicon: "" favicon16x16: "" favicon32x32: "" apple_touch_icon: "" safari_pinned_tab: "" label: text: "Home" icon: /apple-touch-icon.png iconHeight: 35 # profile-mode profileMode: enabled: false # needs to be explicitly set title: ExampleSite imageUrl: "" imageWidth: 120 imageHeight: 120 imageTitle: my image buttons: - name: Posts url: posts - name: Tags url: tags # home-info mode homeInfoParams: Title: "Hi there \U0001F44B" Content: Welcome to my blog socialIcons: - name: twitter url: "https://twitter.com/" - name: stackoverflow url: "https://stackoverflow.com" - name: github url: "https://github.com/" analytics: google: SiteVerificationTag: "XYZabc" cover: hidden: true # hide everywhere but not in structured data hiddenInList: true # hide on list pages and home hiddenInSingle: true # hide on single page # for search # https://fusejs.io/api/options.html fuseOpts: isCaseSensitive: false shouldSort: true location: 0 distance: 1000 threshold: 0.4 minMatchCharLength: 0 keys: ["title", "permalink", "summary", "content"] menu: main: - identifier: categories name: categories url: /categories/ weight: 10 - identifier: tags name: tags url: /tags/ weight: 20 - identifier: example name: example.org url: https://example.org weight: 30 Sample Page.md --- title: "My 1st post" date: 2020-09-15T11:30:03+00:00 weight: 1 aliases: ["/first"] tags: ["first"] author: "Me" # author: ["Me", "You"] # multiple authors showToc: true TocOpen: false draft: false hidemeta: false disableShare: false cover: image: "" # image path/url alt: "" # alt text caption: "" # display caption under cover relative: false # when using page bundles set this to true hidden: true # only hide on current single page comments: false description: "Desc Text." disableHLJS: true # to disable highlightjs ---
Below are variables used with this theme… Site Variables 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 [“Me”,“You”] list To show multiple Authors images string ‘myimage.png’ Link or path of image for opengraph, twitter-cards 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 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.iconHeight integer 35 To set size of label logo image assets.favicon string ‘icon.ico’ To set favicon, can be path or external link 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 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 cover.image string ‘featured.jpg’ To add a 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.relative boolean true | false To use relative path for cover image, used in hugo Page-bundles comments boolean true | false To show/hide comments disableShare boolean true | false To hide/show share icons under a page author [“Me”,“You”] list To show multiple Authors weight integer 5 To set page order or to pin a post to Top of list
Below are variables used with this theme… Site Variables 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 [“Me”,“You”] list To show multiple Authors images string ‘myimage.png’ Link or path of image for opengraph, twitter-cards 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 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.iconHeight integer 35 To set size of label logo image assets.favicon string ‘icon.ico’ To set favicon, can be path or external link 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 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 cover.image string ‘featured.jpg’ To add a 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.relative boolean true | false To use relative path for cover image, used in hugo Page-bundles comments boolean true | false To show/hide comments disableShare boolean true | false To hide/show share icons under a page author [“Me”,“You”] list To show multiple Authors weight integer 5 To set page order or to pin a post to Top of list
Lorem est tota propiore conpellat pectoribus de pectora summo. 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. Exierant elisi ambit vivere dedere Duce pollice Eris modo 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. Comas hunc haec pietate fetum procerum dixit Post torum vates letum Tiresia Flumen querellas Arcanaque montibus omnes Quidem et Vagus elidunt The 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. .canon { background: white; width: 100%; height: auto; }
Hugo ships with several Built-in Shortcodes for rich content, along with a Privacy Config and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds. Instagram Simple Shortcode YouTube Privacy Enhanced Shortcode Twitter Simple Shortcode “In addition to being more logical, asymmetry has the advantage that its complete appearance is far more optically effective than symmetry.” — Jan Tschichold pic.twitter.com/gcv7SrhvJb — Graphic Design History (@DesignReviewed) January 17, 2019 Vimeo Simple Shortcode .__h_video { position: relative; padding-bottom: 56.23%; height: 0; overflow: hidden; width: 100%; background: #000; } .__h_video img { width: 100%; height: auto; color: #000; } .__h_video .play { height: 72px; width: 72px; left: 50%; top: 50%; margin-left: -36px; margin-top: -36px; position: absolute; cursor: pointer; }