git: 5c29fe3832 - main - Fix broken doc package, offline local and online local browsing
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Thu, 29 Oct 2026 09:30:51 UTC
The branch main has been updated by bcr:
URL: https://cgit.FreeBSD.org/doc/commit/?id=5c29fe383286337e6316b0950107596523c2065e
commit 5c29fe383286337e6316b0950107596523c2065e
Author: Elliott Thomas Rhodes <freebsd.trhodes@gmail.com>
AuthorDate: 2026-10-29 09:26:51 +0000
Commit: Benedict Reuschling <bcr@FreeBSD.org>
CommitDate: 2026-10-29 09:30:37 +0000
Fix broken doc package, offline local and online local browsing
Fix a bug that prevents the packaged FreeBSD documentation from being
browsed correctly when built using the offline Hugo configuration.
The offline configuration leaves baseURL empty, causing Hugo to fall
back to https://example.org/. As a result, the generated documentation
contains incorrect links, breaking offline browsing and online browsing
by directing users to example.org. This affects the built package as
well (tested with pkg version: en-freebsd-doc-20260814,1; tested on a
fresh VM with documentation installed using bsdinstall(8)). According to
the Hugo documentation, this is the default behavior when baseurl is not
set.
The fix is to set baseURL = "/" ensuring the generated documentation can
be browsed directly from the file system without requiring the web
server. This also preserves the ability to browse the documentation
through the local server started by 'make run'.
Event: Oslo Hackathon 2026
Pull Request: https://github.com/freebsd/freebsd-doc/pull/731
---
documentation/config/offline/config.toml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/documentation/config/offline/config.toml b/documentation/config/offline/config.toml
index 4075195a1d..c3cb91c364 100644
--- a/documentation/config/offline/config.toml
+++ b/documentation/config/offline/config.toml
@@ -1,6 +1,6 @@
# FreeBSD documentation
-baseURL = ""
+baseURL = "/"
title = "FreeBSD Documentation Portal"
copyright = "BSD 2-clause 'Simplified' License"
defaultContentLanguage = "en"