Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 23 Jan 2023 14:47:48 GMT
From:      "Danilo G. Baio" <dbaio@FreeBSD.org>
To:        doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org
Subject:   git: 48d419160d - main - fdp-primer/doc-build: Add examples for building html for offline usage
Message-ID:  <202301231447.30NElma4072490@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch main has been updated by dbaio:

URL: https://cgit.FreeBSD.org/doc/commit/?id=48d419160d94f271405a4989195e3064421711a9

commit 48d419160d94f271405a4989195e3064421711a9
Author:     Danilo G. Baio <dbaio@FreeBSD.org>
AuthorDate: 2023-01-23 14:46:43 +0000
Commit:     Danilo G. Baio <dbaio@FreeBSD.org>
CommitDate: 2023-01-23 14:46:43 +0000

    fdp-primer/doc-build: Add examples for building html for offline usage
    
    The difference is how Hugo handles links and redirects when generating
    the output.
---
 .../content/en/books/fdp-primer/doc-build/_index.adoc | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
index 00a9ef5827..260769e4ea 100644
--- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
+++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc
@@ -151,6 +151,25 @@ A `hostname` can also be set as base url to Hugo’s internal webserver:
 ....
 ====
 
+[[documentation-build-example-offline]]
+.Build documentation in html for offline usage
+[example]
+====
+[source,shell]
+....
+% cd ~/doc/documentation
+% make html
+....
+
+To compress the html output, add `DOC_HTML_ARCHIVE=1`:
+
+[source,shell]
+....
+% cd ~/doc/documentation
+% DOC_HTML_ARCHIVE=1 make html
+....
+====
+
 [[doc-build-rendering-pdf]]
 === Rendering to pdf
 



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202301231447.30NElma4072490>