1
0
mirror of https://github.com/go-acme/lego.git synced 2025-10-09 10:33:50 +02:00

chore: update documentation theme (#2632)

This commit is contained in:
Ludovic Fernandez
2025-08-28 23:44:26 +02:00
committed by GitHub
parent cb44524070
commit 5c1e21308c
10 changed files with 16 additions and 44 deletions

View File

@@ -12,7 +12,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
env: env:
GO_VERSION: stable GO_VERSION: stable
HUGO_VERSION: 0.131.0 HUGO_VERSION: 0.148.2
CGO_ENABLED: 0 CGO_ENABLED: 0
steps: steps:

View File

@@ -14,7 +14,7 @@ jobs:
env: env:
GO_VERSION: stable GO_VERSION: stable
GOLANGCI_LINT_VERSION: v2.2.1 GOLANGCI_LINT_VERSION: v2.2.1
HUGO_VERSION: 0.131.0 HUGO_VERSION: 0.148.2
CGO_ENABLED: 0 CGO_ENABLED: 0
LEGO_E2E_TESTS: CI LEGO_E2E_TESTS: CI
MEMCACHED_HOSTS: localhost:11211 MEMCACHED_HOSTS: localhost:11211

View File

@@ -54,10 +54,10 @@ detach:
.PHONY: docs-build docs-serve docs-themes .PHONY: docs-build docs-serve docs-themes
docs-build: generate-dns docs-build: generate-dns
@make -C ./docs hugo-build @make -C ./docs build
docs-serve: generate-dns docs-serve: generate-dns
@make -C ./docs hugo @make -C ./docs serve
docs-themes: docs-themes:
@make -C ./docs hugo-themes @make -C ./docs hugo-themes

View File

@@ -1692,7 +1692,7 @@ func displayDNSHelp(w io.Writer, name string) error {
ew.writeln(`Credentials:`) ew.writeln(`Credentials:`)
ew.writeln(` - "SOFTLAYER_API_KEY": Classic Infrastructure API key`) ew.writeln(` - "SOFTLAYER_API_KEY": Classic Infrastructure API key`)
ew.writeln(` - "SOFTLAYER_USERNAME": Username (IBM Cloud is <accountID>_<emailAddress>)`) ew.writeln(` - "SOFTLAYER_USERNAME": Username (IBM Cloud is {accountID}_{emailAddress})`)
ew.writeln() ew.writeln()
ew.writeln(`Additional Configuration:`) ew.writeln(`Additional Configuration:`)

View File

@@ -1,14 +1,14 @@
.PHONY: default clean hugo hugo-build .PHONY: default clean serve build
default: clean hugo default: clean serve
clean: clean:
rm -rf public/ rm -rf public/
hugo-build: clean build: clean
hugo --enableGitInfo --source . hugo --enableGitInfo --source .
hugo: serve:
hugo server --disableFastRender --enableGitInfo --watch --source . hugo server --disableFastRender --enableGitInfo --watch --source .
# hugo server -D # hugo server -D

View File

@@ -39,7 +39,7 @@ lego --email you@example.com --dns ibmcloud -d '*.example.com' -d example.com ru
| Environment Variable Name | Description | | Environment Variable Name | Description |
|-----------------------|-------------| |-----------------------|-------------|
| `SOFTLAYER_API_KEY` | Classic Infrastructure API key | | `SOFTLAYER_API_KEY` | Classic Infrastructure API key |
| `SOFTLAYER_USERNAME` | Username (IBM Cloud is <accountID>_<emailAddress>) | | `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. 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" %}}). More information [here]({{% ref "dns#configuration-and-credentials" %}}).

View File

@@ -2,4 +2,4 @@ module github.com/go-acme/lego/docs
go 1.20 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

View File

@@ -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-20250707094454-9803d5122ebb h1:iTGWOs8uKUaYmd7+wHRyPGXxt+SS5Bhvx2RRboYRXlI=
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/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=

View File

@@ -2,47 +2,19 @@ baseURL = "https://go-acme.github.io/lego/"
languageCode = "en-us" languageCode = "en-us"
title = "Lego" title = "Lego"
# Code highlighting settings
pygmentsCodefences = true
pygmentsCodeFencesGuesSsyntax = false
pygmentsOptions = ""
pygmentsStyle = "monokai"
# The monokai stylesheet is included in the base template.
pygmentsUseClasses = true
[permalinks] [permalinks]
dns = "/dns/:slug/" dns = "/dns/:slug/"
[params] [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 of the site, will be used in meta information
# description = "" # description = ""
# Shows a checkmark for visited pages on the menu # Shows a checkmark for visited pages on the menu
showVisitedLinks = true 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". # Change default color scheme with a variant one. Can be "red", "blue", "green".
themeVariant = "blue" themeVariant = "blue"
custom_css = ["css/theme-custom.css"] custom_css = ["css/theme-custom.css"]
disableLandingPageButton = true disableLandingPageButton = true
hideAuthorEmail = true
# Author of the site, will be used in meta information # Author of the site, will be used in meta information
[params.author] [params.author]
@@ -71,7 +43,7 @@ pygmentsUseClasses = true
weight = 12 weight = 12
[outputs] [outputs]
home = [ "html", "rss", "search", "searchpage"] home = ['html', 'rss', 'print']
[module] [module]
[[module.imports]] [[module.imports]]

View File

@@ -12,7 +12,7 @@ lego --email you@example.com --dns ibmcloud -d '*.example.com' -d example.com ru
[Configuration] [Configuration]
[Configuration.Credentials] [Configuration.Credentials]
SOFTLAYER_USERNAME = "Username (IBM Cloud is <accountID>_<emailAddress>)" SOFTLAYER_USERNAME = "Username (IBM Cloud is {accountID}_{emailAddress})"
SOFTLAYER_API_KEY = "Classic Infrastructure API key" SOFTLAYER_API_KEY = "Classic Infrastructure API key"
[Configuration.Additional] [Configuration.Additional]
SOFTLAYER_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)" SOFTLAYER_POLLING_INTERVAL = "Time between DNS propagation check in seconds (Default: 2)"