Skip to content

Commit b095ba9

Browse files
authored
switch to Hugo modules, upgrade docsy (#221)
1 parent cf43312 commit b095ba9

File tree

9 files changed

+506
-3543
lines changed

9 files changed

+506
-3543
lines changed

.github/workflows/preview-build.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ jobs:
1818
- name: Setup Hugo
1919
uses: peaceiris/actions-hugo@v2
2020
with:
21-
hugo-version: '0.83.1'
21+
hugo-version: '0.101.0'
2222
extended: true
2323

2424
- name: Setup Node
2525
uses: actions/setup-node@v2
2626
with:
27-
node-version: '14'
27+
node-version: '16'
2828

2929
- name: Install and Build
3030
run: |

.gitmodules

-3
This file was deleted.

archetypes/default.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
draft: true
5+
---
6+

config.toml

+24-21
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,19 @@
11
baseURL = "/"
22
title = "LocalStack Docs"
33

4-
enableRobotsTXT = true
5-
6-
# Hugo allows theme composition (and inheritance). The precedence is from left to right.
7-
theme = ["docsy"]
8-
9-
# Will give values to .Lastmod etc.
10-
enableGitInfo = true
11-
124
# Language settings
135
contentDir = "content/en"
146
defaultContentLanguage = "en"
157
defaultContentLanguageInSubdir = false
168
# Useful when translating.
179
enableMissingTranslationPlaceholders = true
1810

19-
# Comment out to disable taxonomies in Docsy
11+
enableRobotsTXT = true
12+
13+
# Will give values to .Lastmod etc.
14+
enableGitInfo = true
15+
16+
# Comment out to enable taxonomies in Docsy
2017
# disableKinds = ["taxonomy", "taxonomyTerm"]
2118

2219
# You can add your own taxonomies
@@ -28,7 +25,7 @@ category = "categories"
2825
# set taxonomyCloud = [] to hide taxonomy clouds
2926
taxonomyCloud = ["tags", "categories"]
3027

31-
# If used, must have same lang as taxonomyCloud
28+
# If used, must have same length as taxonomyCloud
3229
taxonomyCloudTitle = ["Tag Cloud", "Categories"]
3330

3431
# set taxonomyPageHeader = [] to hide taxonomies on the page headers
@@ -48,13 +45,6 @@ pygmentsStyle = "tango"
4845
[permalinks]
4946
blog = "/:section/:year/:month/:day/:slug/"
5047

51-
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
52-
[blackfriday]
53-
plainIDAnchors = true
54-
hrefTargetBlank = true
55-
angledQuotes = false
56-
latexDashes = true
57-
5848
# Image processing configuration.
5949
[imaging]
6050
resampleFilter = "CatmullRom"
@@ -81,10 +71,10 @@ weight = 1
8171
[markup.goldmark.renderer]
8272
unsafe = true
8373
[markup.highlight]
84-
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
85-
style = "tango"
86-
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
87-
# guessSyntax = "true"
74+
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
75+
style = "tango"
76+
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
77+
# guessSyntax = "true"
8878

8979
# Everything below this are Site Params
9080

@@ -213,3 +203,16 @@ enable = false
213203
url = "https://localstack-community.slack.com/"
214204
icon = "fab fa-slack"
215205
desc = "Chat with other project developers"
206+
207+
# hugo module configuration
208+
209+
[module]
210+
[module.hugoVersion]
211+
extended = true
212+
min = "0.75.0"
213+
[[module.imports]]
214+
path = "github.com/google/docsy"
215+
disable = false
216+
[[module.imports]]
217+
path = "github.com/google/docsy/dependencies"
218+
disable = false

go.mod

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
module github.com/localstack/docs
2+
3+
go 1.17
4+
5+
require github.com/google/docsy v0.4.0 // indirect

go.sum

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
github.com/FortAwesome/Font-Awesome v0.0.0-20210804190922-7d3d774145ac/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
2+
github.com/google/docsy v0.4.0 h1:Eyt2aiDC1fnw/Qq/9xnIqUU5n5Yyk4c8gX3nBDdTv/4=
3+
github.com/google/docsy v0.4.0/go.mod h1:vJjGkHNaw9bO42gpFTWwAUzHZWZEVlK46Kx7ikY5c7Y=
4+
github.com/google/docsy/dependencies v0.4.0/go.mod h1:2zZxHF+2qvkyXhLZtsbnqMotxMukJXLaf8fAZER48oo=
5+
github.com/twbs/bootstrap v4.6.1+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=

0 commit comments

Comments
 (0)