2. Set Configuration

Set configuration for Meta data, Images, Footer, Alert, and Edit page.

Open ./config/_default/params.toml in your code editor.

Meta data

Set meta data for Search Engine Optimization (SEO) and Social Media sharing.

Title + Description

Change these settings:

title = "Doks"
titleSeparator = "-"
titleAddition = "Modern Documentation Theme"
description = "Doks is a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."

Open Graph + Twitter Cards

Change these settings:

images = ["doks.png"]
twitterSite = "henkverlinde"
twitterCreator = "henkverlinde"
facebookAuthor = "verlinde.henk"
facebookPublisher = "verlinde.henk"
ogLocale = "en_US"


Change these settings:

schemaType = "Organization"
schemaLogo = "logo-doks.png"
schemaTwitter = "https://twitter.com/henkverlinde"
schemaLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
schemaGitHub = "https://github.com/h-enk"
schemaSection = "blog"

Optionally, change sitelink search box setting — currently not supported by Doks:

siteLinksSearchBox = false

Chrome Browser

Optionally, change Chrome browser theme color:

themeColor = "#fff"


Optionally, change configuration for image shortcodes:

quality = 85
bgColor = "#fff"
landscapePhotoWidths = [1000, 800, 700, 600, 500]
portraitPhotoWidths = [800, 700, 600, 500]
lqipWidth = "20x"

Optionally, change footer message — please leave as is:

footer = "Powered by <a href=\"https://www.netlify.com/\">Netlify</a>, <a href=\"https://gohugo.io/\">Hugo</a>, and <a href=\"https://getdoks.org/\">Doks</a>"


Optionally, change alert message settings — alert shown on homepage only:

alert = false
alertText = "Like Doks? <a class=\"alert-link\" href=\"https://github.com/h-enk/doks/stargazers\">Star on GitHub</a>. Thanks!</a>"

Edit page

Optionally, change edit page settings — you need a git repository to enable:

docsRepo = "https://github.com/h-enk/doks"
editPage = false

Edit this page on GitHub