2020-12-03 16:07:04 +01:00
# Meta Data for SEO
## Homepage
2020-04-15 15:48:16 +02:00
title = "Doks"
titleSeparator = "-"
2020-11-04 08:26:58 +01:00
titleAddition = "Modern Documentation Theme"
2021-10-05 10:35:25 +02:00
description = "Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize."
2020-11-04 08:26:58 +01:00
2021-09-28 16:26:15 +02:00
## Documentation
2021-10-05 10:35:25 +02:00
# docsVersion = "0.3"
2021-09-28 16:26:15 +02:00
2021-06-25 16:04:42 +02:00
## Open Graph
2020-11-04 14:23:52 +01:00
images = [ "doks.png" ]
2020-04-15 15:48:16 +02:00
ogLocale = "en_US"
2021-06-25 16:04:42 +02:00
domainTLD = "doks.netlify.app"
titleHome = "Doks Theme"
## Twitter Cards
twitterSite = "@getdoks"
twitterCreator = "@henkverlinde"
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
## JSON-LD
2021-06-25 16:04:42 +02:00
# schemaType = "Person"
2020-04-15 15:48:16 +02:00
schemaType = "Organization"
2021-06-25 16:04:42 +02:00
schemaName = "Doks"
schemaAuthor = "Henk Verlinde"
schemaAuthorTwitter = "https://twitter.com/henkverlinde"
schemaAuthorLinkedIn = "https://www.linkedin.com/in/henkverlinde/"
schemaAuthorGitHub = "https://github.com/h-enk"
schemaLocale = "en-US"
2020-11-04 14:23:52 +01:00
schemaLogo = "logo-doks.png"
2021-06-25 16:04:42 +02:00
schemaLogoWidth = 512
schemaLogoHeight = 512
schemaImage = "doks.png"
schemaImageWidth = 1280
schemaImageHeight = 640
schemaTwitter = "https://twitter.com/getdoks"
schemaLinkedIn = ""
schemaGitHub = "https://github.com/h-enk/doks"
2020-11-04 08:26:58 +01:00
schemaSection = "blog"
2020-12-03 16:07:04 +01:00
## Sitelinks Search Box
2020-04-15 15:48:16 +02:00
siteLinksSearchBox = false
2020-12-03 16:07:04 +01:00
## Chrome Browser
2020-04-15 15:48:16 +02:00
themeColor = "#fff"
2020-12-03 16:07:04 +01:00
# Images
2020-04-15 15:48:16 +02:00
quality = 85
bgColor = "#fff"
2020-11-16 09:35:51 +01:00
landscapePhotoWidths = [ 900 , 800 , 700 , 600 , 500 ]
2020-11-04 08:26:58 +01:00
portraitPhotoWidths = [ 800 , 700 , 600 , 500 ]
2020-04-15 15:48:16 +02:00
lqipWidth = "20x"
2021-09-23 08:23:25 +02:00
smallLimit = "300"
2020-04-15 15:48:16 +02:00
2022-06-30 11:57:39 +02:00
# Images
imageResponsive = true
imageConvertTo = "webp"
imageImageSizes = [ "480" , "720" , "1080" , "1280" , "1600" , "2048" ]
singleSize = false
imageAddClass = "img-fluid lazyload blur-up"
2020-04-15 15:48:16 +02:00
2022-06-27 14:41:00 +02:00
### Image template
defaultImage = "default-image.png" # put in `./assets/images/`
fillImage = "1270x740 Center" # normalize image size
2020-12-03 16:07:04 +01:00
# Footer
2022-02-01 11:51:28 +01:00
footer = "Powered by <a class=\"text-muted\" href=\"https://www.netlify.com/\">Netlify</a>, <a class=\"text-muted\" href=\"https://gohugo.io/\">Hugo</a>, and <a class=\"text-muted\" href=\"https://getdoks.org/\">Doks</a>"
2021-09-06 10:19:46 +02:00
# Feed
2021-06-25 16:04:42 +02:00
copyRight = "Copyright (c) 2020-2021 Henk Verlinde"
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
# Alert
2020-11-04 08:26:58 +01:00
alert = false
2021-09-07 12:08:46 +02:00
alertDismissable = true
# alertText = "Introducing the Doks child theme, several DX + UX updates, and more! <a class=\"alert-link stretched-link\" href=\"https://getdoks.org/blog/doks-v0.2/\" target=\"_blank\" rel=\"noopener\">Check out Doks v0.2</a>"
alertText = "Introducing the Doks child theme, several DX + UX updates, and more! <a class=\"alert-link stretched-link\" href=\"https://getdoks.org/blog/doks-v0.2/\">Check out Doks v0.2</a>"
2020-11-04 08:26:58 +01:00
2020-12-03 16:07:04 +01:00
# Edit Page
2022-01-20 01:43:20 +01:00
# repoHost [Github | Gitea | GitLab | Bitbucket | BitbucketServer ] is used for building the edit link based on git hoster
2021-10-08 07:44:49 +02:00
repoHost = "GitHub"
#repoHost = "Gitea"
2020-11-04 08:26:58 +01:00
docsRepo = "https://github.com/h-enk/doks"
2021-09-18 07:42:15 +02:00
docsRepoBranch = "master"
2022-01-20 01:36:43 +01:00
docsRepoSubPath = ""
2021-10-08 07:47:12 +02:00
editPage = false
2022-01-17 19:50:23 +01:00
lastMod = false
2021-03-01 16:34:43 +01:00
2022-06-21 12:09:51 +02:00
[ sections ]
sectionNav = [ "docs" , "guides" ]
2021-03-01 16:34:43 +01:00
[ options ]
lazySizes = true
2021-03-19 14:39:07 +01:00
clipBoard = true
2021-03-01 16:34:43 +01:00
instantPage = true
flexSearch = true
2022-06-25 03:07:03 +02:00
searchSectionsShow = [ ]
searchSectionsIndex = [ ]
2021-03-01 16:34:43 +01:00
darkMode = true
2021-04-20 14:57:42 +02:00
bootStrapJs = true
2022-01-26 14:49:48 +01:00
breadCrumb = false
2021-03-16 08:55:07 +01:00
highLight = true
2021-03-17 11:03:35 +01:00
kaTex = false
2022-07-07 11:32:11 +02:00
multilingualMode = true
2021-10-04 16:29:39 +02:00
docsVersioning = false
2022-01-28 09:03:41 +01:00
fullWidth = false
2022-06-10 16:33:08 +02:00
navbarSticky = true
2022-07-05 09:42:04 +02:00
toTopButton = false
2022-07-05 09:16:11 +02:00
scrollSpy = false # experimental; needs Bootstrap >= 5.2.0-beta1
2022-01-20 15:37:15 +01:00
[ menu ]
[ menu . section ]
2022-01-25 16:30:34 +01:00
auto = true
2022-01-26 14:49:48 +01:00
collapsibleSidebar = true