Since this theme processes SCSS to CSS, Hugo needs to be the extended version.
2 Installation
The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this great documentation for beginners.
2.1 Create Your Project
Hugo provides a new command to create a new website:
baseURL="http://example.org/"# [en, zh-cn, fr, ...] determines default content languagedefaultContentLanguage="en"# language codelanguageCode="en"title="My New Hugo Site"# Change the default theme to be use when building the site with Hugotheme="LoveIt"[params]# LoveIt theme versionversion="0.1.X"[menu][[menu.main]]identifier="posts"# you can add extra information before the name (HTML format is supported), such as iconspre=""name="Posts"url="/posts/"# title will be shown when you hover on this menu linktitle=""weight=1[[menu.main]]identifier="tags"pre=""name="Tags"url="/tags/"title=""weight=2[[menu.main]]identifier="categories"pre=""name="Categories"url="/categories/"title=""weight=3
Note
When building the website, you can set a theme by using --theme option. However, we suggest you modify the configuration file (config.toml) and set the theme as the default.
2.4 Create Your First Post
Here is the way to create your first post:
1
hugo new posts/first_post.md
Feel free to edit the post file by adding some sample content and replacing the title value in the beginning of the file.
Note
By default all posts and pages are created as a draft. If you want to render these pages, remove the property draft: true from the metadata or set the property draft: false.
2.5 Launching the Website Locally
Launch by using the following command:
1
hugo serve
Go to http://localhost:1313.
Tip
When you run hugo serve, when the contents of the files change, the page automatically refreshes with the changes.
2.6 Build the Website
When your site is ready to deploy, run the following command:
1
hugo
A public folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.
In addition to Hugo global configuration and menu configuration, LoveIt lets you define the following parameters in your site configuration (here is a config.toml, whose values are default).
Note
Note that some of these parameters are explained in details in other sections of this documentation.
[params]# LoveIt theme versionversion="0.1.X"# site descriptiondescription="This is My New Hugo Site"# site keywordskeywords=["Theme","Hugo"]# site default theme ("light", "dark", "auto")defaultTheme="auto"# public git repo url only then enableGitInfo is truegitRepo=""# which hash function used for SRI, when empty, no SRI is used# ("sha256", "sha384", "sha512", "md5")fingerprint=""# Search[params.search]enable=true# type of search engine ("lunr", "algolia")type="lunr"# index length of the contentcontentLength=5000[params.search.algolia]index=""appID=""searchKey=""# Header info[params.header]# desktop header mode ("fixed", "normal", "auto")desktopMode="fixed"# mobile header mode ("fixed", "normal", "auto")mobileMode="auto"# Footer Copyright Info[params.footer]# Site creation timesince=2019# ICP info only in China (HTML format is supported)icp=""# license info (HTML format is supported)license='<a rel="license external nofollow noopener noreffer" href="https://creativecommons.org/licenses/by-nc/4.0/" target="_blank">CC BY-NC 4.0</a>'# Home Page Info[params.home]# Home Page Profile[params.home.profile]enable=true# Gravatar Email for preferred avatar in home pagegravatarEmail=""# URL of avatar shown in home pageavatarURL="/images/avatar.png"# subtitle shown in home pagesubtitle="This is My New Hugo Site"# whether to use typeit animation for subtitletypeit=true# whether to show social linkssocial=true# disclaimer (HTML format is supported)disclaimer=""# Home Page Posts[params.home.posts]enable=true# special amount of posts in each home posts pagepaginate=6# default behavior when you don't set "hiddenFromHomePage" in front matterdefaultHiddenFromHomePage=false# Social Info in home page[params.social]GitHub="xxxx"Linkedin="xxxx"Twitter="xxxx"Instagram="xxxx"Email="[email protected]"Facebook="xxxx"Telegram="xxxx"# Medium = "xxxx"# Gitlab = "xxxx"Youtubelegacy="xxxx"# Youtubecustom = "xxxx"# Youtubechannel = "xxxx"# Tumblr ="xxxx"# Quora = "xxxx"# Keybase = "xxxx"# Pinterest = "xxxx"# Reddit = "xxxx"# Codepen = "xxxx"# FreeCodeCamp = "xxxx"# Bitbucket = "xxxx"# Stackoverflow = "xxxx"# Weibo = "xxxx"# Odnoklassniki = "xxxx"# VK = "xxxx"# Flickr = "xxxx"# Xing = "xxxx"# Snapchat = "xxxx"# Soundcloud = "xxxx"# Spotify = "xxxx"# Bandcamp = "xxxx"# Paypal = "xxxx"# Fivehundredpx = "xxxx"# Mix = "xxxx"# Goodreads = "xxxx"# Lastfm = "xxxx"# Foursquare = "xxxx"# Hackernews = "xxxx"# Kickstarter = "xxxx"# Patreon = "xxxx"# Steam = "xxxx"# Twitch = "xxxx"# Strava = "xxxx"# Skype = "xxxx"# Whatsapp = "xxxx"# Zhihu = "xxxx"# Douban = "xxxx"# Angellist = "xxxx"# Slidershare = "xxxx"# Jsfiddle = "xxxx"# Deviantart = "xxxx"# Behance = "xxxx"# Dribble = "xxxx"# Wordpress = "xxxx"# Vine = "xxxx"# Googlescholar = "xxxx"# Researchgate = "xxxx"# Mastodon = "xxxx"# MastodonPrefix = "https://mastodon.technology/"# Thingiverse = "xxxx"# Devto = "xxxx"# Gitea = "xxxx"# XMPP = "xxxx"# Matrix = "xxxx"# Bilibili = "xxxx"# Page config[params.page]# whether to use lightgallery in the pagelightgallery=true# whether to show link to Raw Markdown content of the postlinkToMarkdown=true# KaTeX mathematical formulas[params.math]enable=true# default block delimiter is $$ ... $$ and \\[ ... \\]blockLeftDelimiter=""blockRightDelimiter=""# default inline delimiter is $ ... $ and \\( ... \\)inlineLeftDelimiter=""inlineRightDelimiter=""# KaTeX extension copy_texcopyTex=true# KaTeX extension mhchemmhchem=true# Mapbox GL JS config[params.mapbox]# access token of Mapbox GL JSaccessToken=""# style for the light themelightStyle="mapbox://styles/mapbox/light-v9"# style for the dark themedarkStyle="mapbox://styles/mapbox/dark-v9"# whether to add NavigationControlnavigation=true# whether to add GeolocateControlgeolocate=true# whether to add ScaleControlscale=true# whether to add FullscreenControlfullscreen=true# Social Share Links in post page[params.share]enable=trueTwitter=trueFacebook=trueLinkedin=trueWhatsapp=truePinterest=true# Tumblr = trueHackerNews=true# Reddit = true# VK = true# Buffer = true# Xing = true# Line = true# Instapaper = true# Pocket = true# Digg = true# Stumbleupon = true# Flipboard = true# Weibo = true# Renren = true# Myspace = true# Blogger = true# Baidu = true# Odnoklassniki = true# Evernote = true# Skype = true# Trello = true# Mix = true# Comment Config[params.comment]enable=true# Disqus Comment Config[params.comment.disqus]# enable=false# Disqus shortname to use Disqus in postsshortname=""# Gitalk Comment Config[params.comment.gitalk]# enable=falseowner=""repo=""clientId=""clientSecret=""# Valine Comment Config[params.comment.valine]enable=falseappId=""appKey=""placeholder="Your comment ..."notify=falseverify=trueavatar="mp"meta=""pageSize=10lang="en"visitor=truerecordIP=true# Facebook Comment Config[params.comment.facebook]enable=falsewidth="100%"numPosts=10appId=""languageCode="en_US"# Telegram Comments Config[params.comment.telegram]enable=falsesiteID=""limit=5height=""color=""colorful=truedislikes=falseoutlined=false# site verification code for Google/Bing/Yandex/Pinterest/Baidu[params.verification]google=""bing=""yandex=""pinterest=""baidu=""# Publisher Info just for SEO[params.publisher]name="xxxx"[params.publisher.logo]url="logo.png"width=127height=40# Website Log Info just for SEO[params.logo]url="logo.png"width=127height=40# Website Image Info just for SEO[params.image]url="cover.png"width=800height=600# CSS and JS Files CDN[params.cdn]# normalize.css@8.0.1normalizeCSS=''# fontawesome-free@5.12.1fontawesomeFreeCSS=''# [email protected] https://github.com/daneden/animate.cssanimateCSS=''# smooth-scroll@16.1.2smoothScrollJS=''# autocomplete.js@0.37.1autocompleteJS=''# lunr.js@2.3.8lunrJS=''# algoliasearch@4.1.0algoliasearchJS=''# lazysizes@5.2.0lazysizesJS=''# lightgallery.js@1.1.3 [email protected][email protected]lightgalleryCSS=''lightgalleryJS=''lightgalleryThumbnailJS=''lightgalleryZoomJS=''# clipboard.js@2.0.6clipboardJS=''# sharer@0.4.0sharerJS=''# typeit@6.5.1typeitJS=''# katex@0.11.1katexCSS=''katexJS=''katexAutoRenderJS=''katexCopyTexCSS=''katexCopyTexJS=''katexMhchemJS=''# mermaid@8.4.8mermaidJS=''# echarts@4.6.0echartsJS=''echartsMacaronsJS=''# mapbox-gl@1.8.1mapboxGLCSS=''mapboxGLJS=''# aplayer@1.10.1aplayerCSS=''aplayerJS=''# meting@2.0.1metingJS=''# gitalk@1.6.2gitalkCSS=''gitalkJS=''# valine@1.3.10valineJS=''# Markup related configuration in Hugo[markup]# Syntax Highlighting[markup.highlight]codeFences=trueguessSyntax=truelineNos=truelineNumbersInTable=true# false is a necessary configuration# (https://github.com/dillonzq/LoveIt/issues/158)noClasses=false# Goldmark is from Hugo 0.60 the default library used for Markdown[markup.goldmark][markup.goldmark.extensions]definitionList=truefootnote=truelinkify=truestrikethrough=truetable=truetaskList=truetypographer=true[markup.goldmark.renderer]# whether to use HTML tags directly in the documentunsafe=true# Table Of Contents settings[markup.tableOfContents]startLevel=2endLevel=6# Author Info[author]name="xxxx"link=""# Sitemap Info[sitemap]changefreq="weekly"filename="sitemap.xml"priority=0.5# Permalinks Info[Permalinks]# posts = ":year/:month/:filename"posts=":filename"# Privacy Info[privacy][privacy.googleAnalytics]anonymizeIP=true[privacy.youtube]privacyEnhanced=true# Options to make output .md files[mediaTypes][mediaTypes."text/plain"]suffixes=["md"]# Options to make output .md files[outputFormats.MarkDown]mediaType="text/plain"isPlainText=trueisHTML=false# Options to make hugo output files[outputs]# home=["HTML","RSS","JSON"]page=["HTML","MarkDown"]section=["HTML","RSS"]taxonomy=["HTML","RSS"]taxonomyTerm=["HTML"]
Tips about CDN Configuration
Full HTML tags or URLs are supported for CDN configuration:
# [en, zh-cn, fr, pl, ...] determines default content languagedefaultContentLanguage="en"[languages][languages.en]weight=1title="My New Hugo Site"languageCode="en"languageName="English"[[languages.en.menu.main]]identifier="posts"pre=""name="Posts"url="/posts/"title=""weight=1[[languages.en.menu.main]]identifier="tags"pre=""name="Tags"url="/tags/"title=""weight=2[[languages.en.menu.main]]identifier="categories"pre=""name="Categories"url="/categories/"title=""weight=3[languages.zh-cn]weight=2title="我的全新 Hugo 网站"# language code, CN only herelanguageCode="zh-CN"languageName="简体中文"# whether to include Chinese/Japanese/KoreanhasCJKLanguage=true[[languages.zh-cn.menu.main]]identifier="posts"pre=""name="文章"url="/posts/"title=""weight=1[[languages.zh-cn.menu.main]]identifier="tags"pre=""name="标签"url="/tags/"title=""weight=2[[languages.zh-cn.menu.main]]identifier="categories"pre=""name="分类"url="/categories/"title=""weight=3[languages.fr]weight=3title="Mon nouveau site Hugo"languageCode="fr"languageName="Français"[[languages.fr.menu.main]]identifier="posts"pre=""name="Postes"url="/posts/"title=""weight=1[[languages.fr.menu.main]]identifier="tags"pre=""name="Balises"url="/tags/"title=""weight=2[[languages.fr.menu.main]]identifier="categories"name="Catégories"pre=""url="/categories/"title=""weight=3
Then, for each new page, append the language code to the file name.
Single file my-page.md is split in three files:
in English: my-page.en.md
in Chinese: my-page.zh-cn.md
in French: my-page.fr.md
Note
Be aware that only translated pages are displayed in menu. It’s not replaced with default language content.
Translations strings are used for common default values used in the theme. Translations are available in some languages, but you may use another language or want to override default values.
To override these values, create a new file in your local i18n folder i18n/<languageCode>.toml and inspire yourself from themes/LoveIt/i18n/en.toml.
By the way, as these translations could be used by other people, please take the time to propose a translation by making a PR to the theme!
5 Search
Based on Lunr.js or algolia, searching is supported in LoveIt theme.
5.1 Output Configuration
In order to generate index.json for searching, add JSON output file type to the home of the outputs part in your site configuration.
1
2
[outputs]home=["HTML","RSS","JSON"]
5.2 Search Configuration
Based on index.json generated by Hugo, you could activate searching.
[params.search]enable=true# type of search engine ("lunr", "algolia")type="lunr"# index length of the contentcontentLength=5000[params.search.algolia]index=""appID=""searchKey=""
How to choose the type of search engine?
lunr: simple, no need to synchronize index.json, no limit for contentLength,
but high bandwidth and low performance (Especially for Chinese which needs a large segmentit library)
algolia: high performance and low bandwidth, but need to synchronize index.json and limit for contentLength
Tips about algolia
You need to upload index.json files to algolia to activate searching.
You could upload the index.json files by browsers but a script may be a better choice.
To be compatible with Hugo multilingual mode,
you need to upload different index.json for each language to the different index of algolia, such as zh-cn/index.json or fr/index.json…