Since some features of this theme need to processes SCSS to CSS, it is recommended to use Hugo extended version for better experience.
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="DoIt"[params]# DoIt theme versionversion="0.2.X"[menu][[menu.main]]identifier="posts"# you can add extra information before the name (HTML format is supported), such as iconspre=""# you can add extra information after the name (HTML format is supported), such as iconspost=""name="Posts"url="/posts/"# title will be shown when you hover on this menu linktitle=""weight=1[[menu.main]]identifier="tags"pre=""post=""name="Tags"url="/tags/"title=""weight=2[[menu.main]]identifier="categories"pre=""post=""name="Categories"url="/categories/"title=""weight=3# Markup related configuration in Hugo[markup]# Syntax Highlighting (https://gohugo.io/content-management/syntax-highlighting)[markup.highlight]# false is a necessary configuration (https://github.com/dillonzq/LoveIt/issues/158)noClasses=false
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, set the property draft: false or add -D/--buildDrafts parameter to hugo command.
2.5 Launching the Website Locally
Launch by using the following command:
1
hugo serve
Go to http://localhost:1313.
Basic configuration preview
Tip
When you run hugo serve, when the contents of the files change, the page automatically refreshes with the changes.
Note
Since the theme use .Scratch in Hugo to implement some features,
it is highly recommended that you add --disableFastRender parameter to hugo server command for the live preview of the page you are editing.
1
hugo serve --disableFastRender
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, DoIt lets you define the following parameters in your site configuration (here is a config.toml, whose values are default).
Please open the code block below to view the complete sample configuration :
[params]# DoIt theme versionversion="0.3.X"# website titletitle="My New Hugo Site"# site descriptiondescription="This is My New Hugo Site"# site keywordskeywords=["Theme","Hugo"]# site default theme ("light", "dark", "black", "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=""# date formatdateFormat="2006-01-02"# website images for Open Graph and Twitter Cardsimages=["/logo.png"]# enable PWA supportenablePWA=false# [Experimental] cache remote images in markdown, more info: https://github.com/HEIGE-PCloud/DoIt/pull/860#issue-1574342372cacheRemoteImages=true# [Experimental] generate image srcset attribute with hugo image processing feature.optimizeImages=true# [Experimental] resize method for srcset attribute in optimizeImages, more info: https://gohugo.io/content-management/image-processing/#image-processing-optionssrcsetSmallResizeMethod="700x webp Lanczos q75"srcsetDefaultResizeMethod="1200x webp Lanczos q75"srcsetLargeResizeMethod="2000x webp Lanczos q75"# App icon config# License informationlicense='<a rel="license external nofollow noopener noreffer" href="https://creativecommons.org/licenses/by-nc/4.0/" target="_blank">CC BY-NC 4.0</a>'[params.app]# optional site title override for the app when added to an iOS home screen or Android launchertitle="DoIt"# whether to omit favicon resource linksnoFavicon=false# modern SVG favicon to use in place of older style .png and .ico filessvgFavicon=""# Safari mask icon coloriconColor="#5bbad5"# Windows v8-10 tile colortileColor="#da532c"# Search config[params.search]enable=true# type of search engine ("algolia", "fuse")type="fuse"# max index length of the chunked contentcontentLength=4000# placeholder of the search barplaceholder=""# max number of results lengthmaxResultLength=10# snippet length of the resultsnippetLength=30# HTML tag name of the highlight part in resultshighlightTag="em"# whether to use the absolute URL based on the baseURL in search indexabsoluteURL=false[params.search.algolia]index=""appID=""searchKey=""[params.search.fuse]# https://fusejs.io/api/options.htmlisCaseSensitive=falseminMatchCharLength=2findAllMatches=falselocation=0threshold=0.3distance=100ignoreLocation=falseuseExtendedSearch=falseignoreFieldNorm=false# Header config[params.header]# desktop header mode ("fixed", "normal", "auto")desktopMode="fixed"# mobile header mode ("fixed", "normal", "auto")mobileMode="auto"# Theme change mode# theme change mode ("switch", "select")themeChangeMode="select"# Header title config[params.header.title]# URL of the LOGOlogo=""# title namename=""# you can add extra information before the name (HTML format is supported), such as iconspre=""# you can add extra information after the name (HTML format is supported), such as iconspost=""# whether to use typeit animation for title nametypeit=false# Footer config[params.footer]enable=true# Custom content (HTML format is supported)custom=''# whether to show Hugo and theme infohugo=true# Hosted on (HTML format is supported)# <a title="Github Pages" href="https://docs.github.com/en/pages/" target="_blank" rel="noopener noreffer">GitHub Pages</a>hostedOn=''# whether to show copyright infocopyright=true# whether to show the authorauthor=true# 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>'# Section (all posts) page config[params.section]# special amount of posts in each section pagepaginate=20# date format (month and day)dateFormat="01-02"# amount of RSS pagesrss=10# recently updated posts settings[params.section.recentlyUpdated]enable=falserss=falsedays=30maxCount=10# List (category or tag) page config[params.list]# special amount of posts in each list pagepaginate=20# date format (month and day)dateFormat="01-02"# amount of RSS pagesrss=10# Home page config[params.home]# amount of RSS pagesrss=10# Home page profile[params.home.profile]enable=true# Gravatar Email for preferred avatar in home pagegravatarEmail=""# URL of avatar shown in home page# Place your avatar file under static or assets directory# The filepath is relative to the static or assets directoryavatarURL="/images/avatar.webp"# URL the avatar links toavatarLinkURL=""# title shown in home page (HTML format is supported)title=""# 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# replaced with hiddenFromHomePage in params.page# default behavior when you don't set "hiddenFromHomePage" in front matterdefaultHiddenFromHomePage=false# Social config about the author[params.social]GitHub="xxxx"Linkedin=""Twitter="xxxx"Instagram="xxxx"Facebook="xxxx"Telegram="xxxx"Medium=""Gitlab=""Youtubelegacy=""Youtubecustom=""Youtubechannel=""Tumblr=""Quora=""Keybase=""Pinterest=""Reddit=""Codepen=""FreeCodeCamp=""Bitbucket=""Stackoverflow=""Weibo=""Odnoklassniki=""VK=""Flickr=""Xing=""Snapchat=""Soundcloud=""Spotify=""Bandcamp=""Paypal=""Fivehundredpx=""Mix=""Goodreads=""Lastfm=""Foursquare=""Hackernews=""Kickstarter=""Patreon=""Steam=""Twitch=""Strava=""Skype=""Whatsapp=""Zhihu=""Douban=""Angellist=""Slidershare=""Jsfiddle=""Deviantart=""Behance=""Dribbble=""Wordpress=""Vine=""Googlescholar=""Researchgate=""Mastodon=""Thingiverse=""Devto=""Gitea=""XMPP=""Matrix=""Bilibili=""ORCID=""Liberapay=""Ko-Fi=""BuyMeACoffee=""Linktree=""QQ=""QQGroup=""Email="xxxx@xxxx.com"RSS=true# # Page config[params.page]# whether to hide a page from home pagehiddenFromHomePage=false# whether to hide a page from search resultshiddenFromSearch=false# whether to enable twemojitwemoji=false# whether to enable lightgallerylightgallery=false# whether to enable the ruby extended syntaxruby=true# whether to enable the fraction extended syntaxfraction=true# whether to enable the fontawesome extended syntaxfontawesome=true# whether to show link to Raw Markdown content of the contentlinkToMarkdown=true# configure the link to the source file of the postlinkToSource=false# "https://github.com/user/repo/blob/main/{path}"# configure the link to edit the postlinkToEdit=false# "https://github.com/user/repo/edit/main/{path}"# "https://gitlab.com/user/repo/-/edit/main/{path}"# "https://bitbucket.org/user/repo/src/main/{path}?mode=edit"# configure the link to report issue for the postlinkToReport=false# "https://github.com/user/repo/issues/new?title=[bug]%20{title}&body=|Field|Value|%0A|-|-|%0A|Title|{title}|%0A|Url|{url}|%0A|Filename|https://github.com/user/repo/blob/main/{path}|"# whether to show the full text content in RSSrssFullText=false# whether to enable series navigationseriesNavigation=true# whether to enable last modified timeenableLastMod=true# whether to enable word countenableWordCount=true# whether to enable reading time estimationenableReadingTime=true# outdated article reminder config[params.page.outdatedArticleReminder]enable=false# Display the reminder if the last modified time is more than 90 days ago.reminder=90# Display warning if the last modified time is more than 180 days ago.warning=180# Table of the contents config[params.page.toc]# whether to enable the table of the contentsenable=true# whether to keep the static table of the contents in front of the postkeepStatic=true# whether to make the table of the contents in the sidebar automatically collapsedauto=true# KaTeX mathematical formulas[params.page.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# Code config[params.page.code]# whether to show the copy button of the code blockcopy=true# the maximum number of lines of displayed code by defaultmaxShownLines=10# Table config[params.page.table]# whether to enable sorting in the tablessort=true# Mapbox GL JS config[params.page.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.page.share]enable=trueTwitter=trueFacebook=trueLinkedin=falseWhatsapp=truePinterest=falseTumblr=falseHackerNews=falseReddit=falseVK=falseBuffer=falseXing=falseLine=trueInstapaper=falsePocket=falseDigg=falseStumbleupon=falseFlipboard=falseWeibo=trueRenren=falseMyspace=trueBlogger=trueBaidu=falseOdnoklassniki=falseEvernote=trueSkype=falseTrello=falseMix=falseMastodon=false# instant.page config[params.page.instantpage]enable=false# Comment config[params.page.comment]enable=true# Disqus comment config[params.page.comment.disqus]# enable=false# Disqus shortname to use Disqus in postsshortname=""# Gitalk comment config[params.page.comment.gitalk]# enable=falseowner=""repo=""clientId=""clientSecret=""# Valine comment config[params.page.comment.valine]enable=falseappId=""appKey=""placeholder=""avatar="mp"meta=""pageSize=10lang=""visitor=truerecordIP=truehighlight=trueenableQQ=falseserverURLs=""# emoji data file name, default is "google.yml"# ("apple.yml", "google.yml", "facebook.yml", "twitter.yml")# located in "themes/DoIt/assets/data/emoji/" directory# you can store your own data files in the same path under your project:# "assets/data/emoji/"emoji=""# Waline comment config[params.page.comment.waline]# enable=falseserverURL=""pageview=truecomment=true# emoji = ['https://cdn.jsdelivr.net/gh/walinejs/emojis/weibo']# meta = ['nick', 'mail', 'link']# requiredMeta = []# login = 'enable'# wordLimit = 0# pageSize = 10# imageUploader = false# highlighter = false# texRenderer = false# Facebook comment config[params.page.comment.facebook]enable=falsewidth="100%"numPosts=10appId=""languageCode=""# Telegram comments config[params.page.comment.telegram]enable=falsesiteID=""limit=5height=""color=""colorful=truedislikes=falseoutlined=falsedark=false# Commento comment config[params.page.comment.commento]enable=false# Utterances comment config[params.page.comment.utterances]enable=false# owner/reporepo=""issueTerm="pathname"label=""lightTheme="github-light"darkTheme="github-dark"# Twikoo comment config[params.page.comment.twikoo]enable=falseenvId=""region=""path=""cloudbase=true# boolean : true / false. #If you deploy your Twikoo on CloudBase, set it to true.visitor=truecommentCount=true# Vssue comment config[params.page.comment.vssue]enable=falseplatform=""# ("bitbucket", "gitea", "gitee", "github", "gitlab")owner=""repo=""clientId=""clientSecret=""# Remark42 comment config[params.page.comment.remark42]enable=falsehost=""site_id=""max_shown_comments=15show_email_subscription=truesimple_view=false# giscus comment config[params.page.comment.giscus]enable=false# owner/repodataRepo=""dataRepoId=""dataCategory=""dataCategoryId=""dataMapping="pathname"dataReactionsEnabled="1"dataEmitMetadata="0"dataInputPosition="bottom"lightTheme="light"darkTheme="dark"dataLang="en"dataLoading="lazy"# artalk comment config[params.page.comment.artalk]enable=falseserver=""site=""lite=falsekatex=falselightbox=falsepageview=truecommentCount=true# Third-party library config[params.page.library][params.page.library.css]# someCSS = "some.css"# Enhance third-party library config# [params.page.library.css.someOtherCSS]# src = "someOther.css"# defer = true# attr = "customAttribute"# located in "assets/"# Or# someCSS = "https://cdn.example.com/some.css"[params.page.library.js]# someJavaScript = "some.js"# Enhance third-party library config# [params.page.library.js.someOtherJavaScript]# src = "someOther.js"# defer = false# async = true# attr = "customAttribute"# located in "assets/"# Or# someJavaScript = "https://cdn.example.com/some.js"# Page SEO config[params.page.seo]# image URLimages=[]# Publisher info[params.page.seo.publisher]name=""logoUrl=""# Related content config[params.page.related]enable=truecount=5# Sponsor config[params.sponsor]enable=falsebio="If you find this post helpful, please consider sponsoring."link="https://www.buymeacoffee.com"# The link to your sponsor pagecustom=""# Custom HTML button# TypeIt config[params.typeit]# typing speed between each step (measured in milliseconds)speed=100# blinking speed of the cursor (measured in milliseconds)cursorSpeed=1000# character used for the cursor (HTML format is supported)cursorChar="|"# cursor duration after typing finishing (measured in milliseconds, "-1" means unlimited)duration=-1# Site verification code config for Google/Bing/Yandex/Pinterest/Baidu[params.verification]google=""bing=""yandex=""pinterest=""baidu=""so=""# 360 searchsogou=""# Site SEO config[params.seo]# image URLimage=""# thumbnail URLthumbnailUrl=""# # alternate site name in Google search resultalternateName=["Hugo DoIt"]# Analytics config[params.analytics]enable=false# Google Analytics[params.analytics.google]id=""# whether to anonymize IPanonymizeIP=true# Fathom Analytics[params.analytics.fathom]id=""# server url for your tracker if you're self hostingserver=""# Baidu Analytics[params.analytics.baidu]id=""# Umami Analytics[params.analytics.umami]data_website_id=""src=""data_host_url=""data_domains=""# Plausible Analytics[params.analytics.plausible]data_domain=""src=""# Cloudflare Analytics[params.analytics.cloudflare]token=""# Cookie consent config[params.cookieconsent]enable=true# text strings used for Cookie consent banner[params.cookieconsent.content]message=""dismiss=""link=""# CDN config for third-party library files[params.cdn]# CDN data file name, disabled by default# ("jsdelivr.yml")# located in "themes/DoIt/assets/data/cdn/" directory# you can store your own data files in the same path under your project:# "assets/data/cdn/"data=""# Compatibility config[params.compatibility]# whether to use Polyfill.io on cdnjs to be compatible with older browsers# https://blog.cloudflare.com/polyfill-io-now-available-on-cdnjs-reduce-your-supply-chain-riskpolyfill=false# whether to use object-fit-images to be compatible with older browsersobjectFit=false# Markup related config 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 config[author]name="xxxx"email=""link=""avatar=""gravatarEmail=""# Sitemap config[sitemap]changefreq="weekly"filename="sitemap.xml"priority=0.5# Permalinks config[Permalinks]# posts = ":year/:month/:filename"posts=":filename"# Privacy config[privacy]# privacy of the Google Analytics (replaced by params.analytics.google)[privacy.googleAnalytics]# ...[privacy.twitter]enableDNT=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"]# Options for taxonomies[taxonomies]author="authors"category="categories"tag="tags"series="series"
Note
Note that some of these parameters are explained in details in other sections of this documentation.
Hugo environments
Default environments are development with hugo serve and production with hugo.
Due to limitations in the local development environment,
the comment system, CDN and fingerprint will not be enabled in the development environment.
You could enable these features with hugo serve -e production.
Tips about avatar Configuration
1
2
3
4
5
6
7
8
[params.home.profile]enable=true# Gravatar Email for preferred avatar in home pagegravatarEmail=""# URL of avatar shown in home pageavatarURL="/images/avatar.webp"# URL the avatar links toavatarLinkURL=""
You can sign up and configure your avatar at Gravatar, the website will automatically obtain and set your avatar through the email address filled in gravatarEmail.
Or you can place image files in the /assets or /static directory, and configure the address under avatarURL to display the avatar. The file path of the referenced resource is relative to the assets or static directory. Please refer to this document for detailed local resource reference method.
Tips about CDN Configuration
1
2
3
4
[params.cdn]# CDN data file name, disabled by default# ("jsdelivr.yml")data=""
The default CDN data file is located in themes/DoIt/assets/data/cdn/ directory.
You can store your own data file in the same path under your project: assets/data/cdn/.
Tips about social Configuration
You can directly set your ID to get a default social link and its icon:
1
2
[params.social]Mastodon="@xxxx"
The social link generated is https://mastodon.technology/@xxxx.
Or You can set more options through a dict:
1
2
3
4
5
6
7
8
9
10
[params.social][params.social.Mastodon]# weight when arranging icons (the greater the weight, the later the icon is positioned)weight=0# your social IDid="@xxxx"# prefix of your social linkprefix="https://mastodon.social/"# content hovering on the icontitle="Mastodon"
The default data of all supported social links is located in themes/DoIt/assets/data/social.yaml,
which is you can refer to.
# [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=""post=""name="Posts"url="/posts/"title=""weight=1[[languages.en.menu.main]]identifier="tags"pre=""post=""name="Tags"url="/tags/"title=""weight=2[[languages.en.menu.main]]identifier="categories"pre=""post=""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=""post=""name="文章"url="/posts/"title=""weight=1[[languages.zh-cn.menu.main]]identifier="tags"pre=""post=""name="标签"url="/tags/"title=""weight=2[[languages.zh-cn.menu.main]]identifier="categories"pre=""post=""name="分类"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 two files:
in English: my-page.en.md
in Chinese: my-page.zh-cn.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/DoIt/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 algolia, searching is supported in DoIt 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 ("algolia", "fuse")type="fuse"# max index length of the chunked contentcontentLength=4000# placeholder of the search barplaceholder=""# max number of results lengthmaxResultLength=10# snippet length of the resultsnippetLength=30# HTML tag name of the highlight part in resultshighlightTag="em"# whether to use the absolute URL based on the baseURL in search indexabsoluteURL=false[params.search.algolia]index=""appID=""searchKey=""[params.search.fuse]# https://fusejs.io/api/options.htmlisCaseSensitive=falseminMatchCharLength=2findAllMatches=falselocation=0threshold=0.3distance=100ignoreLocation=falseuseExtendedSearch=falseignoreFieldNorm=false
How to choose search engine?
The following is a comparison of two search engines:
fuse: simple, no need to synchronize index.json, no limit for contentLength, high performance
algolia: high performance and low bandwidth, but need to synchronize index.json and limit for contentLength
The content of the post is separated by h2 and h3 HTML tag to improve query performance and basically implement full-text search.
contentLength is used to limit the max index length of the part starting with h2 and h3 HTML tag.
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 CLI tool may be better.
Algolia Atomic is a good 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…
If you find this post helpful, please consider sponsoring.
DoIt
PCloud
The content of the post is separated by 