2. Set Configuration

Set configuration for Meta data, Images, Footer, Feed, Global alert, Edit page, and Options.

On this page

💡

Visual Studio Code is a free code editor for Linux, macOS, and Windows.

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

Meta data

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

Title + Description

Change these settings:

  1. ## Homepage
  2. title = "Doks"
  3. titleSeparator = "-"
  4. titleAddition = "Modern Documentation Theme"
  5. description = "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."

Open Graph + Twitter Cards

Change these settings:

  1. ## Open Graph
  2. images = ["doks.png"]
  3. ogLocale = "en_US"
  4. domainTLD = "doks.netlify.app"
  5. titleHome = "Doks Theme"
  7. ## Twitter Cards
  8. twitterSite = "@getdoks"
  9. twitterCreator = "@henkverlinde"

👉

Put your image in the static folder.

JSON-LD

Change these settings:

  1. ## JSON-LD
  2. # schemaType = "Person"
  3. schemaType = "Organization"
  4. schemaName = "Doks"
  5. schemaAuthor = "Henk Verlinde"
  6. schemaAuthorTwitter = "https://twitter.com/henkverlinde"
  7. schemaAuthorLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
  8. schemaAuthorGitHub = "https://github.com/h-enk"
  9. schemaLocale = "en-US"
  10. schemaLogo = "logo-doks.png"
  11. schemaLogoWidth = 512
  12. schemaLogoHeight = 512
  13. schemaImage = "doks.png"
  14. schemaImageWidth = 1280
  15. schemaImageHeight = 640
  16. schemaTwitter = "https://twitter.com/getdoks"
  17. schemaLinkedIn = ""
  18. schemaGitHub = "https://github.com/h-enk/doks"
  19. schemaSection = "blog"

👉

Put your logo in the static folder.

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

  1. ## Sitelinks Search Box
  2. siteLinksSearchBox = false

Chrome Browser

Optionally, change Chrome browser theme color:

  1. ## Chrome Browser
  2. themeColor = "#fff"

Images

Optionally, change configuration for image shortcodes:

  1. # Images
  2. quality = 85
  3. bgColor = "#fff"
  4. landscapePhotoWidths = [900, 800, 700, 600, 500]
  5. portraitPhotoWidths = [800, 700, 600, 500]
  6. lqipWidth = "20x"
  7. smallLimit = "300"

Optionally, change footer message — please leave as is:

  1. # Footer
  2. 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>"

Feed

Change RSS feed copyright notice:

  1. # Feed
  2. copyRight = "Copyright (c) 2020-2021 Henk Verlinde"

Global alert

Optionally, change the global alert message (visible on all pages when activated). Switch it on by setting alert = true and make it dismissible by setting alertDismissable = true:

  1. # Alert
  2. alert = true
  3. alertDismissable = true
  4. alertText = "Help Doks grow by supporting us on Open Collective. <a class=\"alert-link stretched-link\" href=\"https://opencollective.com/doks\" target=\"_blank\" rel=\"noopener\">Become a backer!</a>"

Edit page

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

  1. # Edit Page
  2. docsRepo = "https://github.com/h-enk/doks"
  3. docsRepoBranch = "master"
  4. editPage = false

Options

  1. [options]
  2.   lazySizes = true
  3.   clipBoard = true
  4.   instantPage = true
  5.   flexSearch = true
  6.   darkMode = true
  7.   bootStrapJs = true
  8.   breadCrumb = false
  9.   highLight = true
  10.   kaTex = false
  11.   collapsibleSidebar = true
  12.   multilingualMode = false
  13.   docsVersioning = false