diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 46f7f673..c0bbbfbd 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -12,7 +12,7 @@ jobs: runs-on: ubuntu-latest env: GO_VERSION: stable - HUGO_VERSION: 0.131.0 + HUGO_VERSION: 0.148.2 CGO_ENABLED: 0 steps: diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index cb5966f3..b68a7810 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -14,7 +14,7 @@ jobs: env: GO_VERSION: stable GOLANGCI_LINT_VERSION: v2.2.1 - HUGO_VERSION: 0.131.0 + HUGO_VERSION: 0.148.2 CGO_ENABLED: 0 LEGO_E2E_TESTS: CI MEMCACHED_HOSTS: localhost:11211 diff --git a/Makefile b/Makefile index 28cb3390..8536dfc4 100644 --- a/Makefile +++ b/Makefile @@ -54,10 +54,10 @@ detach: .PHONY: docs-build docs-serve docs-themes docs-build: generate-dns - @make -C ./docs hugo-build + @make -C ./docs build docs-serve: generate-dns - @make -C ./docs hugo + @make -C ./docs serve docs-themes: @make -C ./docs hugo-themes diff --git a/cmd/zz_gen_cmd_dnshelp.go b/cmd/zz_gen_cmd_dnshelp.go index 9a4e2480..d49670f1 100644 --- a/cmd/zz_gen_cmd_dnshelp.go +++ b/cmd/zz_gen_cmd_dnshelp.go @@ -1692,7 +1692,7 @@ func displayDNSHelp(w io.Writer, name string) error { ew.writeln(`Credentials:`) ew.writeln(` - "SOFTLAYER_API_KEY": Classic Infrastructure API key`) - ew.writeln(` - "SOFTLAYER_USERNAME": Username (IBM Cloud is _)`) + ew.writeln(` - "SOFTLAYER_USERNAME": Username (IBM Cloud is {accountID}_{emailAddress})`) ew.writeln() ew.writeln(`Additional Configuration:`) diff --git a/docs/Makefile b/docs/Makefile index 8e32681d..6c84c7d1 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,14 +1,14 @@ -.PHONY: default clean hugo hugo-build +.PHONY: default clean serve build -default: clean hugo +default: clean serve clean: rm -rf public/ -hugo-build: clean +build: clean hugo --enableGitInfo --source . -hugo: +serve: hugo server --disableFastRender --enableGitInfo --watch --source . # hugo server -D diff --git a/docs/content/dns/zz_gen_ibmcloud.md b/docs/content/dns/zz_gen_ibmcloud.md index c2f9f4fe..94997b70 100644 --- a/docs/content/dns/zz_gen_ibmcloud.md +++ b/docs/content/dns/zz_gen_ibmcloud.md @@ -39,7 +39,7 @@ lego --email you@example.com --dns ibmcloud -d '*.example.com' -d example.com ru | Environment Variable Name | Description | |-----------------------|-------------| | `SOFTLAYER_API_KEY` | Classic Infrastructure API key | -| `SOFTLAYER_USERNAME` | Username (IBM Cloud is _) | +| `SOFTLAYER_USERNAME` | Username (IBM Cloud is {accountID}_{emailAddress}) | The environment variable names can be suffixed by `_FILE` to reference a file instead of a value. More information [here]({{% ref "dns#configuration-and-credentials" %}}). diff --git a/docs/go.mod b/docs/go.mod index 5cb2add4..2240eb1e 100644 --- a/docs/go.mod +++ b/docs/go.mod @@ -2,4 +2,4 @@ module github.com/go-acme/lego/docs go 1.20 -require github.com/McShelby/hugo-theme-relearn v0.0.0-20240802145348-259f21f89851 +require github.com/McShelby/hugo-theme-relearn v0.0.0-20250707094454-9803d5122ebb diff --git a/docs/go.sum b/docs/go.sum index 1ed963e8..b62d5c80 100644 --- a/docs/go.sum +++ b/docs/go.sum @@ -1,2 +1,2 @@ -github.com/McShelby/hugo-theme-relearn v0.0.0-20240802145348-259f21f89851 h1:JpmKIb1bRzuAcgnphwSb35Xz9rk/Alq19uRWVGSwScA= -github.com/McShelby/hugo-theme-relearn v0.0.0-20240802145348-259f21f89851/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM= +github.com/McShelby/hugo-theme-relearn v0.0.0-20250707094454-9803d5122ebb h1:iTGWOs8uKUaYmd7+wHRyPGXxt+SS5Bhvx2RRboYRXlI= +github.com/McShelby/hugo-theme-relearn v0.0.0-20250707094454-9803d5122ebb/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM= diff --git a/docs/hugo.toml b/docs/hugo.toml index a974cea7..b17206d4 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -2,47 +2,19 @@ baseURL = "https://go-acme.github.io/lego/" languageCode = "en-us" title = "Lego" -# Code highlighting settings -pygmentsCodefences = true -pygmentsCodeFencesGuesSsyntax = false -pygmentsOptions = "" -pygmentsStyle = "monokai" -# The monokai stylesheet is included in the base template. -pygmentsUseClasses = true - [permalinks] dns = "/dns/:slug/" [params] - # Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page. - # Useful to give opportunity to people to create merge request for your doc. - # See the config.toml file from this documentation site to have an example. -# editURL = "" # Description of the site, will be used in meta information # description = "" # Shows a checkmark for visited pages on the menu showVisitedLinks = true - # Disable search function. It will hide search bar -# disableSearch = false - # Javascript and CSS cache are automatically busted when new version of site is generated. - # Set this to true to disable this behavior (some proxies don't handle well this optimization) -# disableAssetsBusting = false - # Set this to true to disable copy-to-clipboard button for inline code. -# disableInlineCopyToClipBoard = true - # A title for shortcuts in menu is set by default. Set this to true to disable it. -# disableShortcutsTitle = false - # When using mulitlingual website, disable the switch language button. -# disableLanguageSwitchingButton = false - # Hide breadcrumbs in the header and only show the current page title -# disableBreadcrumb = true - # Hide Next and Previous page buttons normally displayed full height beside content -# disableNextPrev = true - # Order sections in menu by "weight" or "title". Default to "weight" -# ordersectionsby = "weight" # Change default color scheme with a variant one. Can be "red", "blue", "green". themeVariant = "blue" custom_css = ["css/theme-custom.css"] disableLandingPageButton = true + hideAuthorEmail = true # Author of the site, will be used in meta information [params.author] @@ -71,7 +43,7 @@ pygmentsUseClasses = true weight = 12 [outputs] - home = [ "html", "rss", "search", "searchpage"] + home = ['html', 'rss', 'print'] [module] [[module.imports]] diff --git a/providers/dns/ibmcloud/ibmcloud.toml b/providers/dns/ibmcloud/ibmcloud.toml index 090c010c..2a6c12f8 100644 --- a/providers/dns/ibmcloud/ibmcloud.toml +++ b/providers/dns/ibmcloud/ibmcloud.toml @@ -12,7 +12,7 @@ lego --email you@example.com --dns ibmcloud -d '*.example.com' -d example.com ru [Configuration] [Configuration.Credentials] - SOFTLAYER_USERNAME = "Username (IBM Cloud is _)" + SOFTLAYER_USERNAME = "Username (IBM Cloud is {accountID}_{emailAddress})" SOFTLAYER_API_KEY = "Classic Infrastructure API key" [Configuration.Additional] SOFTLAYER_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"