diff options
Diffstat (limited to 'documentation/content/en/books/fdp-primer/doc-build/_index.adoc')
| -rw-r--r-- | documentation/content/en/books/fdp-primer/doc-build/_index.adoc | 38 |
1 files changed, 29 insertions, 9 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 fe360864e5..ce14bf2cdf 100644 --- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc +++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc @@ -6,7 +6,8 @@ description: Describes the FreeBSD Documentation Build Process tags: ["build", "process", "make"] showBookMenu: true weight: 6 -path: "/books/fdp-primer/" +params: + path: "/books/fdp-primer/doc-build/" --- [[doc-build]] @@ -115,13 +116,13 @@ To render the documentation and the website to `html` use one of the following e Advanced build examples are given below: [[documentation-build-example-verbose]] -.Build the documentation with verbose and debug messages +.Build English and Spanish documentation with verbose and debug messages [example] ==== [source,shell] .... % cd ~/doc/documentation -% make HUGO_ARGS="--verbose --debug --path-warnings" +% make DOC_LANG="en es" HUGO_ARGS="--verbose --debug" .... ==== @@ -136,11 +137,11 @@ Advanced build examples are given below: .... This webserver runs on `localhost`, port `1313` by default. -To serve the content with Hugo’s internal webserver binding a specific IP address: +To serve the content with Hugo’s internal webserver binding a specific IP address and port: [source,shell] .... -% make run BIND=192.168.15.10 +% make run BIND=192.168.15.10 HUGO_ARGS="-p 8080" .... A `hostname` can also be set as base url to Hugo’s internal webserver: @@ -151,6 +152,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 @@ -239,8 +259,8 @@ This [.filename]#Makefile# takes the following form: .... # Generate the FreeBSD documentation # -# Copyright (c) 2020-2021, The FreeBSD Documentation Project -# Copyright (c) 2020-2021, Sergio Carlavilla <carlavilla@FreeBSD.org> +# Copyright (c) 2020-2025, The FreeBSD Documentation Project +# Copyright (c) 2020-2025, Sergio Carlavilla <carlavilla@FreeBSD.org> # # Targets intended for use on the command line # @@ -529,8 +549,8 @@ This [.filename]#Makefile# takes the form of: .... # Generate the FreeBSD website # -# Copyright (c) 2020-2021, The FreeBSD Documentation Project -# Copyright (c) 2020-2021, Sergio Carlavilla <carlavilla@FreeBSD.org> +# Copyright (c) 2020-2025, The FreeBSD Documentation Project +# Copyright (c) 2020-2025, Sergio Carlavilla <carlavilla@FreeBSD.org> # # Targets intended for use on the command line # |