Skip to content

Commit 1d267dd

Browse files
johnnymatthewsjohnnymatthews
committed
Clarifies which folders to ignore.
1 parent ea95fb6 commit 1d267dd

File tree

28 files changed

+1027
-2
lines changed

28 files changed

+1027
-2
lines changed

Diff for: ‎.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,5 @@ resources
44
.netlify
55
.hugo_build.lock
66
.DS_Store
7-
content
8-
config
7+
./content
8+
./config

Diff for: ‎example-site/config/_default/config.toml

+110
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
baseurl = "/"
2+
canonifyURLs = false
3+
disableAliases = false
4+
disableHugoGeneratorInject = true
5+
enableEmoji = true
6+
enableGitInfo = false
7+
enableRobotsTXT = true
8+
paginate = 7
9+
rssLimit = 10
10+
11+
# Multilingual
12+
defaultContentLanguage = "en"
13+
disableLanguages = ["de", "nl"]
14+
# defaultContentLanguageInSubdir = true
15+
16+
# add redirects/headers
17+
[outputs]
18+
home = ["HTML", "RSS", "REDIRECTS", "HEADERS"]
19+
section = ["HTML", "RSS", "SITEMAP"]
20+
21+
# remove .{ext} from text/netlify
22+
[mediaTypes."text/netlify"]
23+
suffixes = [""]
24+
delimiter = ""
25+
26+
# add output format for netlify _redirects
27+
[outputFormats.REDIRECTS]
28+
mediaType = "text/netlify"
29+
baseName = "_redirects"
30+
isPlainText = true
31+
notAlternative = true
32+
33+
# add output format for netlify _headers
34+
[outputFormats.HEADERS]
35+
mediaType = "text/netlify"
36+
baseName = "_headers"
37+
isPlainText = true
38+
notAlternative = true
39+
40+
# add output format for section sitemap.xml
41+
[outputFormats.SITEMAP]
42+
mediaType = "application/xml"
43+
baseName = "sitemap"
44+
isHTML = false
45+
isPlainText = true
46+
noUgly = true
47+
rel = "sitemap"
48+
49+
[caches]
50+
[caches.getjson]
51+
dir = ":cacheDir/:project"
52+
maxAge = "10s"
53+
54+
[sitemap]
55+
changefreq = "weekly"
56+
filename = "sitemap.xml"
57+
priority = 0.5
58+
59+
[taxonomies]
60+
contributor = "contributors"
61+
category = "categories"
62+
tag = "tags"
63+
64+
[permalinks]
65+
blog = "/blog/:title/"
66+
# docs = "/docs/1.0/:sections[1:]/:title/"
67+
68+
[minify.tdewolff.html]
69+
keepWhitespace = false
70+
71+
[related]
72+
threshold = 80
73+
includeNewer = true
74+
toLower = false
75+
[[related.indices]]
76+
name = "categories"
77+
weight = 100
78+
[[related.indices]]
79+
name = "tags"
80+
weight = 80
81+
[[related.indices]]
82+
name = "date"
83+
weight = 10
84+
85+
[module]
86+
[module.hugoVersion]
87+
extended = true
88+
min = "0.80.0"
89+
max = ""
90+
[[module.mounts]]
91+
source = "assets"
92+
target = "assets"
93+
[[module.mounts]]
94+
source = "static"
95+
target = "static"
96+
[[module.mounts]]
97+
source = "layouts"
98+
target = "layouts"
99+
[[module.mounts]]
100+
source = "node_modules/flexsearch"
101+
target = "assets/js/vendor/flexsearch"
102+
[[module.mounts]]
103+
source = "node_modules/katex"
104+
target = "assets/js/vendor/katex"
105+
[[module.mounts]]
106+
source = "node_modules/mermaid"
107+
target = "assets/js/vendor/mermaid"
108+
[[module.mounts]]
109+
source = "node_modules/@hyas/images/layouts"
110+
target = "layouts"

Diff for: ‎example-site/config/_default/languages.toml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[en]
2+
languageName = "English"
3+
contentDir = "content/en"
4+
weight = 10
5+
[en.params]
6+
languageISO = "EN"
7+
languageTag = "en-US"
8+
9+
[de]
10+
languageName = "German"
11+
contentDir = "content/de"
12+
weight = 15
13+
[de.params]
14+
languageISO = "DE"
15+
languageTag = "de-DE"
16+
17+
[nl]
18+
languageName = "Nederlands"
19+
contentDir = "content/nl"
20+
weight = 20
21+
[nl.params]
22+
languageISO = "NL"
23+
languageTag = "nl-NL"
24+
titleAddition = "Modern documentatie-thema"
25+
description = "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard."
26+
titleHome = "Doks thema"
27+
footer = "Mogelijk gemaakt door <a href=\"https://www.netlify.com/\">Netlify</a>, <a href=\"https://gohugo.io/\">Hugo</a>, en <a href=\"https://getdoks.org/\">Doks</a>"
28+
alertText = "Introductie van het Doks-kinderthema, verschillende DX + UX-updates en meer! <a class=\"alert-link stretched-link\" href=\"https://getdoks.org/blog/doks-v0.2/\">Bekijk Doks v0.2</a>"

Diff for: ‎example-site/config/_default/markup.toml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
defaultMarkdownHandler = "goldmark"
2+
3+
[goldmark]
4+
[goldmark.extensions]
5+
linkify = false
6+
[goldmark.parser]
7+
autoHeadingID = true
8+
autoHeadingIDType = "github"
9+
[goldmark.parser.attribute]
10+
block = true
11+
title = true
12+
[goldmark.renderer]
13+
unsafe = true
14+
15+
[highlight]
16+
codeFences = false
17+
guessSyntax = false
18+
hl_Lines = ""
19+
lineNoStart = 1
20+
lineNos = false
21+
lineNumbersInTable = true
22+
noClasses = false
23+
style = "dracula"
24+
tabWidth = 4
25+
26+
[tableOfContents]
27+
endLevel = 3
28+
ordered = false
29+
startLevel = 2

Diff for: ‎example-site/config/_default/menus/menus.en.toml

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
[[main]]
2+
name = "Basics"
3+
url = "/basics/install/windows/"
4+
weight = 1
5+
6+
[[main]]
7+
name = "Support"
8+
weight = 30
9+
identifier = "dropdown"
10+
url = "/"
11+
12+
[[main]]
13+
name = "Contact"
14+
weight = 40
15+
identifier = "dropdown-first-item"
16+
url = "/contact"
17+
parent = "dropdown"
18+
19+
[[main]]
20+
name = "Slack channel"
21+
weight = 50
22+
identifier = "dropdown-second-item"
23+
url = "https://example.com"
24+
parent = "dropdown"
25+
26+
[[main]]
27+
name = "Blog"
28+
url = "/blog/"
29+
weight = 20
30+
31+
32+
33+
[[social]]
34+
name = "GitHub"
35+
pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-github\"><path d=\"M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22\"></path></svg>"
36+
url = "https://github.com/protocol/docs-starter"
37+
post = "v0.1.0"
38+
weight = 10
39+
40+
[[social]]
41+
name = "Twitter"
42+
pre = "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"20\" height=\"20\" viewBox=\"0 0 24 24\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\" class=\"feather feather-twitter\"><path d=\"M23 3a10.9 10.9 0 0 1-3.14 1.53 4.48 4.48 0 0 0-7.86 3v1A10.66 10.66 0 0 1 3 4s-4 9 5 13a11.64 11.64 0 0 1-7 2c9 5 20 0 20-11.5a4.5 4.5 0 0 0-.08-.83A7.72 7.72 0 0 0 23 3z\"></path></svg>"
43+
url = "https://twitter.com/protocollabs"
44+
weight = 20
45+
46+
47+
48+
[[footer]]
49+
name = "Privacy"
50+
url = "/privacy"
51+
weight = 10
52+
53+
[[footer]]
54+
name = "Terms"
55+
url = "/terms"
56+
weight = 20
57+
58+
[[footer]]
59+
name = "Contact"
60+
url = "/contact"
61+
weight = 30

Diff for: ‎example-site/config/_default/params.toml

+114
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Meta Data for SEO
2+
3+
## Homepage
4+
title = "Docs Website"
5+
titleSeparator = "-"
6+
titleAddition = "A simple documentation platform."
7+
description = "This documentation platform helps teams write, build, and deploy a simple documentation site that's easy for users to navigate."
8+
9+
## Documentation
10+
# docsVersion = "0.3"
11+
12+
## Open Graph
13+
images = [""]
14+
ogLocale = ""
15+
domainTLD = ""
16+
titleHome = ""
17+
18+
## Twitter Cards
19+
twitterSite = ""
20+
twitterCreator = ""
21+
22+
## JSON-LD
23+
# schemaType = "Person"
24+
schemaType = ""
25+
schemaName = ""
26+
schemaAuthor = ""
27+
schemaAuthorTwitter = ""
28+
schemaAuthorLinkedIn = ""
29+
schemaAuthorGitHub = ""
30+
schemaLocale = ""
31+
schemaLogo = ""
32+
schemaLogoWidth = 512
33+
schemaLogoHeight = 512
34+
schemaImage = ""
35+
schemaImageWidth = 1280
36+
schemaImageHeight = 640
37+
schemaTwitter = ""
38+
schemaLinkedIn = ""
39+
schemaGitHub = ""
40+
schemaSection = ""
41+
42+
## Sitelinks Search Box
43+
siteLinksSearchBox = false
44+
45+
## Chrome Browser
46+
themeColor = "#fff"
47+
48+
# Images
49+
quality = 85
50+
bgColor = "#fff"
51+
landscapePhotoWidths = [900, 800, 700, 600, 500]
52+
portraitPhotoWidths = [800, 700, 600, 500]
53+
lqipWidth = "20x"
54+
smallLimit = "300"
55+
56+
# Images
57+
imageResponsive = true
58+
imageConvertTo = "webp"
59+
imageImageSizes = ["480","720","1080","1280","1600","2048"]
60+
singleSize = false
61+
imageAddClass = "img-fluid lazyload blur-up"
62+
63+
### Image template
64+
defaultImage = "default-image.png" # put in `./assets/images/`
65+
fillImage = "1270x740 Center" # normalize image size
66+
67+
# Footer
68+
footer = ""
69+
# footer = 'Powered by <a class="text-muted" href="example.com">Example</a>, <a class="text-muted" href="https://gohugo.io">Hugo</a>, and <a class="text-muted" href="https://protocol.ai">Protocol Labs</a>'
70+
71+
# Feed
72+
copyRight = ""
73+
# copyRight = "Copyright (c) Protocol Labs"
74+
75+
# Alert
76+
alert = true
77+
alertDismissable = true
78+
alertText = "This alert pops up at the top of the webpage. It's useful to ask users for cookies and all that GDPR stuff. If you're happy with us using cooking, <a href='#'>click here</a>."
79+
80+
# Edit Page
81+
repoHost = "GitHub"
82+
# repoHost [Github | Gitea | GitLab | Bitbucket | BitbucketServer ]
83+
docsRepo = ""
84+
docsRepoBranch = ""
85+
docsRepoSubPath = ""
86+
editPage = false
87+
lastMod = false
88+
89+
[sections]
90+
sectionNav = ["docs", "blog"]
91+
92+
[options]
93+
lazySizes = true
94+
clipBoard = true
95+
instantPage = true
96+
flexSearch = true
97+
searchSectionsShow = "ALL"
98+
searchSectionsIndex = "ALL"
99+
darkMode = true
100+
bootStrapJs = true
101+
breadCrumb = false
102+
highLight = true
103+
kaTex = false
104+
multilingualMode = false
105+
docsVersioning = false
106+
fullWidth = true
107+
navbarSticky = true
108+
toTopButton = false
109+
scrollSpy = false # experimental; needs Bootstrap >= 5.2.0-beta1
110+
111+
[menu]
112+
[menu.section]
113+
auto = true
114+
collapsibleSidebar = false

Diff for: ‎example-site/config/next/config.toml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
canonifyURLs = false

0 commit comments

Comments
 (0)