aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDanilo G. Baio <dbaio@FreeBSD.org>2023-01-23 14:46:43 +0000
committerDanilo G. Baio <dbaio@FreeBSD.org>2023-01-23 14:46:43 +0000
commit48d419160d94f271405a4989195e3064421711a9 (patch)
tree5fd6774290fbb2cf7747ecc27c28a264ad196149
parentb49fa4aa4c05266e26fdec0bfc003762186912f5 (diff)
downloaddoc-48d419160d.tar.gz
doc-48d419160d.zip
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.
-rw-r--r--documentation/content/en/books/fdp-primer/doc-build/_index.adoc19
1 files changed, 19 insertions, 0 deletions
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