Here is the default configuration and basic parameters for your website. You can change those as per your requirements.
Default configuration
In this project folder, you will find a file called config/_default/config.toml
. Open this file in any text editor or IDE.
- baseURL field for your website URL / domain. Add your site URL here. Remember, you need to add a trailing slash at the end of the URL.
- languageCode defines your global site language. For more information, see Official Hugo Docs.
- title is for the main title of your website.
- theme sets up the used theme. If your theme is located in
my-project/themes/theme-name
folder, then the value for this parameter istheme-name
. - summaryLength decides how many words are in excerpts of your posts when they are displayed as a preview. The default
summaryLength
is 70 words. - paginate set the number of posts shown on blog overview pages. If you have more than this amount of posts, pagination will be visible to navigate the next set of posts.
- disqusShortname add your Disqus shortname to enable comments on the blog section. To install Disqus please follow this tutorial.
- googleAnalytics add your Google Analytics ID to enable analytics on all pages. # example: UA-123-45. For more info, read the article. If you want another third-party analytics, you can contact us for custom service.
Default Parameters
In this project folder, you will find a file called config/_default/params.toml
. Open this file in any text editor or IDE.
- favicon is for your website favicon. Place your favicon in the
assets/images
folder and put the path here. - logo is for your website logo. Place your logo in the
assets/images
folder and put the path here. - logo_width defines the width of the logo in pixels. It doesn’t work with .svg file.
- logo_text will only appear if the logo parameter is missing.
- description is for your default meta description. It shows on your homepage and other pages that have no meta description on this page front-matter.
- author is for the website author name. It is used in the meta author tag.
- image is used as the fallback for
open graph
and twitter card
if a page has no image of its own. - contact_form_action is for activate your contact form. As Hugo generates a static site, so you need to activate this form by a third-party service. You can use any of them Airform, formspree, or Formsubmit. Go to any of the sites that you preferred, and get your form action from there. Then, paste it here. If you use Airform, your form action will be like this:
https://airform.io/your@email.com
. - mainSections defines the section names that you want to show on your website. It’s an array, so you can add more sections to show. For more information, see Official docs.
- contact_info has some filed (like
phone
, email
, and address
) to show your contact information in the footer and contact page. - preloader is for your website preloader, which means it will show up until your website loads properly in the background. You can enable or disable preloader by setting the value of
enable
as true
or false
. If you want to put any image, logo, or animation as your preloader, give the file location in the preloader =
, ex: preloader = images/preloader.gif
. If you don’t want any logo or image, leave the preloader field empty. So it will show just a white screen when every component is loading. - social is a loop item for your website’s social icons. You can add a loop item by following the existing loop. We are using Line Awesome icon pack for this theme. You can choose more icons from here
Default Parameters
assets/images
folder and put the path here.assets/images
folder and put the path here.open graph
and twitter card
if a page has no image of its own.https://airform.io/your@email.com
.phone
, email
, and address
) to show your contact information in the footer and contact page.enable
as true
or false
. If you want to put any image, logo, or animation as your preloader, give the file location in the preloader =
, ex: preloader = images/preloader.gif
. If you don’t want any logo or image, leave the preloader field empty. So it will show just a white screen when every component is loading.Logo
field is for your site logo, you can set a default logo for your site, just give here the logo directory.- Home is for home in your navigation.
description
field is for your default meta description, it will show on your homepage and other page that have not any meta description on this page front-matter.googleAnalitycsID
is for turn on google analytics on your site, give your won analytics ID here.contactFormAction
is for enable contact form in contact page, contact form works with formspree.copyright
is for copyright text in the very bottom of the page.preloader
is for site preloader, you can enable or disable preloader by enable = true or false, then if you want any image, logo, or animation in preloader then give the location inpreloader =
, likepreloader = images/preloader.gif
or if you don’t want any logo or image then leave the preloader field empty, then it will show just a white screen when every component is loading. that’s simple.Search
is for blog post search, you can enable or disable it from here.