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 them out-of-the-box. Name Age Bob 27 Alice 23 Inline Markdown within tables Italics Bold Code italics bold code Code Blocks Inline Code This is Inline Code Only pre This is pre text Code block with backticks Example HTML5 Document Test Code block with backticks and language specified 1 2 3 4 5 6 7 8 9 10 11 html lang="en" head meta charset="utf-8" / titleExample HTML5 Documenttitle meta name="description" content="Sample article showcasing basic Markdown syntax and formatting for HTML elements." 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 Gist 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 GIF is a bitmap image format. H2O Xn + Yn = Zn Press CTRL+ALT+Delete to end the session. Most salamanders are 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 them out-of-the-box. Name Age Bob 27 Alice 23 Inline Markdown within tables Italics Bold Code italics bold code Code Blocks Inline Code This is Inline Code Only pre This is pre text Code block with backticks Example HTML5 Document Test Code block with backticks and language specified 1 2 3 4 5 6 7 8 9 10 11 html lang="en" head meta charset="utf-8" / titleExample HTML5 Documenttitle meta name="description" content="Sample article showcasing basic Markdown syntax and formatting for HTML elements." 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 Gist 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 GIF is a bitmap image format. H2O Xn + Yn = Zn Press CTRL+ALT+Delete to end the session. Most salamanders are 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 them out-of-the-box. Name Age Bob 27 Alice 23 Inline Markdown within tables Italics Bold Code italics bold code Code Blocks Inline Code This is Inline Code Only pre This is pre text Code block with backticks Example HTML5 Document Test Code block with backticks and language specified 1 2 3 4 5 6 7 8 9 10 11 html lang="en" head meta charset="utf-8" / titleExample HTML5 Documenttitle meta name="description" content="Sample article showcasing basic Markdown syntax and formatting for HTML elements." 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 Gist 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 GIF is a bitmap image format. H2O Xn + Yn = Zn Press CTRL+ALT+Delete to end the session. Most salamanders are 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 (extend_head.html) like so: refer ISSUE #236 {{ 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:productionor 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:trueLinked 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/ 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:categoriesname:categoriesurl:/categories/weight:10- identifier:tagsname:tagsurl:/tags/weight:20- identifier:examplename:example.orgurl:https://example.orgweight:30name 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:00weight:1------title:"My 2nd Important post"date:2020-09-15T11:30:03+00:00weight: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 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  When using figure shortcode use align=center to center image with captions ex. {{ figure align=center src="image.jpg" }} Using Hugo’s Syntax highlighter “chroma” Disable Highlight.js in site config.yml params:assets:disableHLJS:true Set hugo’s markdown styling in site config.yml markup:highlight:# anchorLineNos: truecodeFences:trueguessSyntax:truelineNos:true# noClasses: falsestyle:monokai If you want lineNos: true, the background won’t be proper. This will only work with noClasses: false or pygmentsUseClasses: true. Read Generate Syntax Highlighter CSS Add the following to assets/css/extended/custom.css .chroma { background-color: unset; } More Info : Configure Markup - Highlight Search not working ? If you are using a CDN to server assets from a different domain, search would break Why? Take a look at fastsearch.js#L35. We fetch the index.json (where the search function looks for the keywords typed) one level up of the website search.min.js is hosted on. We have used this insted of assigning baseURL so as to work with multilingual websites ex. example.com/fr/ and websites being placed under a subdirectory ex. example.com/blog/. To fix for single language websites hosting assets from CDN, this you may override fastsearch.js#L35 and placing appropriate URL as in xhr.open("GET", "https://example.com/index.json"); 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. 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/integrity check. Default Theme light/dark/auto params:# defaultTheme: light# defaultTheme: darkdefaultTheme: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:trueYou 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 . ├── config.yml ├── content/ │ ├── archives.md │ └── posts/ ├── static/ └── themes/ └── PaperMod/ and add the following to it ---title:"Archive"layout:"archives"url:"/archives/"summary:archives---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 waveContent:Can be Info, links, about...socialIcons:# optional- name:""url:""- name:""url:""ex. config.yml#L106 Profile Mode Shows Index/Home page as Full Page with Social Links and Image add following to config file params:profileMode:enabled:truetitle:""# optional default will be site titlesubtitle:"This is subtitle"imageUrl:""# optionalimageTitle:""# optionalimageWidth:120# custom sizeimageHeight:120# custom sizebuttons:- name:Archiveurl:"/archive"- name:Githuburl:"https://github.com/"socialIcons:# optional- name:""url:""- name:""url:"" Search Page PaperMod uses Fuse.js Basic for seach functionality Add the following to site config, config.yml outputs:home:- HTML- RSS- JSON# is necessaryCreate a page with search.md in content directory with following content ---title:"Search"# in any language you wantlayout:"search"# is necessary# url: "/archive"# description: "Description for Search"summary:"search"---To hide a particular page from being searched, add it in post’s fron’t matter ---searchHidden:trueex: 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..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:falseshouldSort:truelocation:0distance:1000threshold:0.4minMatchCharLength:0keys:["title","permalink","summary","content"] 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.pngalt:""caption:""relative:false# To use relative path for cover image, used in hugo Page-bundlesWhen 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:falseTo 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:trueTo keep Toc Open by default on a post add following to page-variables: TocOpen:true BreadCrumb Navigation Adds BreadCrumb Navigation above Post’s Title to show subsections and Navigation to Home params:ShowBreadCrumbs:trueCan be diabled for particular page’s front-matter ---ShowBreadCrumbs:false--- Edit Link for Posts Add a button to suggest changes by using the file path of the post to link to a edit destination. For site config use: Params:editPost:URL:"https://github.com//content"Text:"Suggest Changes"# edit textappendFilePath:true# to append file path to Edit linkCan be modified for individual pages ---editPost:URL:"https://github.com//content"Text:"Suggest Changes"# edit textappendFilePath:true# to append file path to Edit link---The example above would yield the following link for the post file posts/post-name.md: https://github.com//content/posts/post-name.md Parameter Required Default Value editPost.URL true - editPost.appendFilePath false false editPost.Text false “Edit” Since the link generated is a regular HTML anchor tag , you can also use other URL schemas like mailto://, e.g. URL: "mailto://mail@example.com?subject=Suggesting changes for " Other Posts suggestion below a post Adds a Previous / Next post suggestion under a single post params:ShowPostNavLinks: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:trueread more about this hugo-comments 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: production Rich Results/Snippets Support Twitter Cards Support The Twitter Cards metadata, except twitter:image should not require additional configuration, since it is generated from metadata that you should already have (for instance the page title and description). The twitter:image uses the Post Cover Image, if present. In the absence of a cover images, the first image from the images frontmatter (a list) is used. images:- image_01.png- image_02.png Finally, if neither of those are provided, twitter:image comes from the first Page Bundle image with feature in the name, with a fallback to the first image with cover or thumbnail in the name. OpenGraph support The OpenGraph metadata, except og:image should not require additional configuration, since it is generated from metadata that you should already have (for instance the page title and description). The og:image uses the Post Cover Image, if present. In the absence of a cover images, the first image from the images frontmatter (a list) is used. images:- image_01.png- image_02.png Finally, if neither of those are provided, og:image comes from the first Page Bundle image with feature in the name, with a fallback to the first image with cover or thumbnail in the name. For pages, you can also add audio (using frontmatter audio: filename.ext) and/or videos. videos:- filename01.mov- filename02.avi 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 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: params:ShowShareButtons:true
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. Guide Follow Quick Start guide to setup hugo and create a new site. Note: Use -f to select yml format hugo new site -f yml Make sure you install latest version of hugo(=0.83.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 v5.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 # needed when you reclone your repo (submodules may not get cloned automatically) Note: You may use --branch v5.0 to end of above command if you want to stick to specific release. Updating theme : git submodule update --remote --merge Method 3 Or you can Download as Zip from Github Page and extract in your themes directory Direct Links: Master Branch (Latest) v5.0 v4.0 v3.0 v2.0 v1.0 Finally … Add in config.yml: theme:"PaperMod"Method 4 Install Go programming language in your operating system. Intialize your own hugo mod hugo mod init YOUR_OWN_GIT_REPOSITORY Add PaperMod in your config.yml file module: imports: - path: github.com/adityatelange/hugo-PaperMod Update theme hugo mod get -u Quick Links Papermod - Features Papermod - FAQs Papermod - Variables Papermod - Icons ChangeLog Sample config.yml Example Site Structure is present here: exampleSite Use appropriately baseURL:"https://examplesite.com/"title:ExampleSitepaginate:5theme:PaperModenableRobotsTXT:truebuildDrafts:falsebuildFuture:falsebuildExpired:falsepygmentsUseClasses:truegoogleAnalytics:UA-123-45minify:disableXML:trueminifyOutput:trueparams:env:production# to enable google analytics, opengraph, twitter-cards and schema.title:ExampleSitedescription:"ExampleSite description"keywords:[Blog, Portfolio, PaperMod]author:Me# author: ["Me", "You"] # multiple authorsimages:[""]DateFormat:"January 2, 2006"defaultTheme:auto# dark, lightdisableThemeToggle:falseShowReadingTime:trueShowShareButtons:trueShowPostNavLinks:trueShowBreadCrumbs:trueShowCodeCopyButtons:falsedisableSpecial1stPost:falsedisableScrollToTop:falsecomments:falsehidemeta:falsehideSummary:falseshowtoc:falsetocopen:falseassets:# disableHLJS: true # to disable highlight.js# disableFingerprinting: truefavicon:""favicon16x16:""favicon32x32:""apple_touch_icon:""safari_pinned_tab:""label:text:"Home"icon:/apple-touch-icon.pngiconHeight:35# profile-modeprofileMode:enabled:false# needs to be explicitly settitle:ExampleSitesubtitle:"This is subtitle"imageUrl:""imageWidth:120imageHeight:120imageTitle:my imagebuttons:- name:Postsurl:posts- name:Tagsurl:tags# home-info modehomeInfoParams:Title:"Hi there \U0001F44B"Content:Welcome to my blogsocialIcons:- name:twitterurl:"https://twitter.com/"- name:stackoverflowurl:"https://stackoverflow.com"- name:githuburl:"https://github.com/"analytics:google:SiteVerificationTag:"XYZabc"bing:SiteVerificationTag:"XYZabc"yandex:SiteVerificationTag:"XYZabc"cover:hidden:true# hide everywhere but not in structured datahiddenInList:true# hide on list pages and homehiddenInSingle:true# hide on single pageeditPost:URL:"https://github.com//content"Text:"Suggest Changes"# edit textappendFilePath:true# to append file path to Edit link# for search# https://fusejs.io/api/options.htmlfuseOpts:isCaseSensitive:falseshouldSort:truelocation:0distance:1000threshold:0.4minMatchCharLength:0keys:["title","permalink","summary","content"]menu:main:- identifier:categoriesname:categoriesurl:/categories/weight:10- identifier:tagsname:tagsurl:/tags/weight:20- identifier:examplename:example.orgurl:https://example.orgweight:30# Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma# pygmentsUseClasses: true# markup:# highlight:# # anchorLineNos: true# codeFences: true# guessSyntax: true# lineNos: true# style: monokai 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 authorsshowToc:trueTocOpen:falsedraft:falsehidemeta:falsecomments:falsedescription:"Desc Text."canonicalURL:"https://canonical.url/to/page"disableHLJS:true# to disable highlightjsdisableShare:falsedisableHLJS:falsehideSummary:falsesearchHidden:trueShowReadingTime:trueShowBreadCrumbs:trueShowPostNavLinks:truecover:image:""# image path/urlalt:""# alt textcaption:""# display caption under coverrelative:false# when using page bundles set this to truehidden:true# only hide on current single pageeditPost:URL:"https://github.com//content"Text:"Suggest Changes"# edit textappendFilePath:true# to append file path to Edit link---You can use it by creating archetypes/post.md hugo new --kind post
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. Guide Follow Quick Start guide to setup hugo and create a new site. Note: Use -f to select yml format hugo new site -f yml Make sure you install latest version of hugo(=0.83.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 v5.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 # needed when you reclone your repo (submodules may not get cloned automatically) Note: You may use --branch v5.0 to end of above command if you want to stick to specific release. Updating theme : git submodule update --remote --merge Method 3 Or you can Download as Zip from Github Page and extract in your themes directory Direct Links: Master Branch (Latest) v5.0 v4.0 v3.0 v2.0 v1.0 Finally … Add in config.yml: theme:"PaperMod"Method 4 Install Go programming language in your operating system. Intialize your own hugo mod hugo mod init YOUR_OWN_GIT_REPOSITORY Add PaperMod in your config.yml file module: imports: - path: github.com/adityatelange/hugo-PaperMod Update theme hugo mod get -u Quick Links Papermod - Features Papermod - FAQs Papermod - Variables Papermod - Icons ChangeLog Sample config.yml Example Site Structure is present here: exampleSite Use appropriately baseURL:"https://examplesite.com/"title:ExampleSitepaginate:5theme:PaperModenableRobotsTXT:truebuildDrafts:falsebuildFuture:falsebuildExpired:falsepygmentsUseClasses:truegoogleAnalytics:UA-123-45minify:disableXML:trueminifyOutput:trueparams:env:production# to enable google analytics, opengraph, twitter-cards and schema.title:ExampleSitedescription:"ExampleSite description"keywords:[Blog, Portfolio, PaperMod]author:Me# author: ["Me", "You"] # multiple authorsimages:[""]DateFormat:"January 2, 2006"defaultTheme:auto# dark, lightdisableThemeToggle:falseShowReadingTime:trueShowShareButtons:trueShowPostNavLinks:trueShowBreadCrumbs:trueShowCodeCopyButtons:falsedisableSpecial1stPost:falsedisableScrollToTop:falsecomments:falsehidemeta:falsehideSummary:falseshowtoc:falsetocopen:falseassets:# disableHLJS: true # to disable highlight.js# disableFingerprinting: truefavicon:""favicon16x16:""favicon32x32:""apple_touch_icon:""safari_pinned_tab:""label:text:"Home"icon:/apple-touch-icon.pngiconHeight:35# profile-modeprofileMode:enabled:false# needs to be explicitly settitle:ExampleSitesubtitle:"This is subtitle"imageUrl:""imageWidth:120imageHeight:120imageTitle:my imagebuttons:- name:Postsurl:posts- name:Tagsurl:tags# home-info modehomeInfoParams:Title:"Hi there \U0001F44B"Content:Welcome to my blogsocialIcons:- name:twitterurl:"https://twitter.com/"- name:stackoverflowurl:"https://stackoverflow.com"- name:githuburl:"https://github.com/"analytics:google:SiteVerificationTag:"XYZabc"bing:SiteVerificationTag:"XYZabc"yandex:SiteVerificationTag:"XYZabc"cover:hidden:true# hide everywhere but not in structured datahiddenInList:true# hide on list pages and homehiddenInSingle:true# hide on single pageeditPost:URL:"https://github.com//content"Text:"Suggest Changes"# edit textappendFilePath:true# to append file path to Edit link# for search# https://fusejs.io/api/options.htmlfuseOpts:isCaseSensitive:falseshouldSort:truelocation:0distance:1000threshold:0.4minMatchCharLength:0keys:["title","permalink","summary","content"]menu:main:- identifier:categoriesname:categoriesurl:/categories/weight:10- identifier:tagsname:tagsurl:/tags/weight:20- identifier:examplename:example.orgurl:https://example.orgweight:30# Read: https://github.com/adityatelange/hugo-PaperMod/wiki/FAQs#using-hugos-syntax-highlighter-chroma# pygmentsUseClasses: true# markup:# highlight:# # anchorLineNos: true# codeFences: true# guessSyntax: true# lineNos: true# style: monokai 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 authorsshowToc:trueTocOpen:falsedraft:falsehidemeta:falsecomments:falsedescription:"Desc Text."canonicalURL:"https://canonical.url/to/page"disableHLJS:true# to disable highlightjsdisableShare:falsedisableHLJS:falsehideSummary:falsesearchHidden:trueShowReadingTime:trueShowBreadCrumbs:trueShowPostNavLinks:trueShowRssButtonInSectionTermList:truecover:image:""# image path/urlalt:""# alt textcaption:""# display caption under coverrelative:false# when using page bundles set this to truehidden:true# only hide on current single pageeditPost:URL:"https://github.com//content"Text:"Suggest Changes"# edit textappendFilePath:true# to append file path to Edit link---You can use it by creating archetypes/post.md hugo new --kind post
Below are variables used with this theme… Site Variables under Params name type example Description env string ‘production’ To set env to production title string ‘My Blog’ To set title description string ‘This is a blog of mine’ To set site description author string |list ‘Me’ | [‘Me’,‘You’] To show multiple Authors images string ‘myimage.png’ Link or path of image for opengraph, twitter-cards keywords list [blog, page] Add keywords for Home page DateFormat string “January 2, 2006” The format of date strings in the website. Details languageAltTitle string “English” Alternate title in Multilingual Mode ShowReadingTime boolean true | false To show read time in post meta ShowShareButtons boolean true | false To show/hide share buttons under post ShowCodeCopyButtons boolean true | false To show/hide Code Copy button ShowFullTextinRSS boolean true | false To show Content in RSS feed defaultTheme string light | dark | auto To set default theme disableThemeToggle boolean true | false To disable theme toggle icon shown besides label disableSpecial1stPost boolean true | false To disable no-card special appearance of 1st post disableScrollToTop boolean true | false To disable ScrollToTop button disableAnchoredHeadings boolean true | false To disable Anchored Headings hideMeta boolean true | false To Hide meta elements : date, read-time, author and available-translations for page hideSummary boolean true | false To Hide summary being shown in list pages showtoc boolean true | false To show/hide Table of Contents tocopen boolean true | false To keep open ToC by default on page load ShowPostNavLinks boolean true | false Show Previous and Next Posts below a Post ShowBreadCrumbs boolean true | false Show BreadCrumb Navigation above single post/page comments boolean true | false To show/hide comments analytics.google.SiteVerificationTag string “XYZabc” Site Verification Tag for Google Analytics analytics.bing.SiteVerificationTag string “XYZabc” Site Verification Tag for Bing analytics.yandex.SiteVerificationTag string “XYZabc” Site Verification Tag for Yandex schema - - Details fuseOpts - - Details socialIcons - - Details label - - Details assets - - Details cover - - Details profileMode - - Details editPost - - Details Site Variables name type example Description copyright string **[example.site](https://example.site)** This is HUGO’s site variable, which can also render markdown content label name type example Description 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 profileMode name type example Description profileMode.enabled boolean true | false For enabling profileMode, needs to be explicitly set profileMode.title string “Title” Title profileMode.subtitle string “subtitle here” Subtitle profileMode.imageUrl string “image.png” | “https://example.com/image.jpg" Image URL or Link profileMode.imageWidth string “150” Width of image profileMode.imageHeight string “150” Height of image profileMode.imageTitle string “This image is a picture of ..” Title of image profileMode.buttons - - Details profileMode.buttons profileMode:buttons:- name:Archiveurl:"/archive"- name:Githuburl:"https://github.com/"assets name type example Description assets.favicon string ‘icon.ico’ To set favicon, can be path or external link assets.disableHLJS boolean true | false To disable Highlight.js loading assets.disableFingerprinting boolean true | false To disable Sub-Resource integrity for assets cover name type example Description 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.hidden boolean true | false To hide everywhere but not in structured data cover.hiddenInList boolean true | false To hide on list pages and home cover.hiddenInSingle boolean true | false To hide on list pages and home schema name type example Description schema.publisherType string ‘Organization’ https://schema.org/publisher schema.sameAs list [“URL1”, “URL2”] Set https://schema.org/sameAs fuseOpts Refer: https://fusejs.io/api/options.html fuseOpts:isCaseSensitive:falseshouldSort:truelocation:0distance:1000threshold:0.4minMatchCharLength:0keys:["title","permalink","summary","content"]## can be less but not more than shown in listsocialIcons socialIcons:- name:""url:""- name:""url:""editPost editPost:URL:"https://github.com//content"Text:"Suggest Changes"# edit textappendFilePath:true# to append file path to Edit link Note: Same format is being used by Page Variables Page Variables Name Type Example Description showtoc boolean true | false To show/hide Table of Contents tocopen boolean true | false To keep open ToC by default on page load hidemeta boolean true | false To Hide meta elements : date, read-time, author and available-translations for page comments boolean true | false To show/hide comments description string ‘description text’ Show Post Description under Title canonicalURL string “https://canonical.url/to/page" To add canonical URL to posts disableShare boolean true | false To hide/show share icons under a page disableHLJS boolean true | false To disable Highlight.js loading disableAnchoredHeadings boolean true | false To disable Anchored Headings searchHidden boolean true | false Hide page from search hideSummary boolean true | false To Hide summary being shown in list pages ShowReadingTime boolean true | false To show read time in post meta ShowBreadCrumbs boolean true | false Show BreadCrumb Navigation above single post/page ShowPostNavLinks boolean true | false Show Previous and Next Posts below a Post author string |list ‘Me’ | [‘Me’,‘You’] To show multiple Authors cover.image string ‘featured.jpg’ To add a cover image cover.caption string ‘caption for image’ To add caption to cover image 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.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