diff --git a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc --- a/documentation/content/en/books/fdp-primer/doc-build/_index.adoc +++ b/documentation/content/en/books/fdp-primer/doc-build/_index.adoc @@ -89,6 +89,57 @@ .... ==== +Advanced build examples are given below: + +[[documentation-build-example-verbose]] +.Build the documentation with verbose and debug messages +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make HUGO_ARGS="--verbose --debug --path-warnings" +.... +==== + +[[documentation-build-example-server]] +.Build and serve the content with Hugo’s internal webserver +[example] +==== +[source,shell] +.... +% cd ~/doc/documentation +% make run +.... +This webserver runs on `localhost`, port `1313` by default. + +To serve the content with Hugo’s internal webserver binding a specific IP address: + +[source,shell] +.... +% make run BIND=192.168.15.10 +.... + +A `hostname` can also be set as base url to Hugo’s internal webserver: + +[source,shell] +.... +% make run BIND=192.168.15.10 HOSTNAME=example.com +.... +==== + +[[documentation-build-example-english]] +.Build only the English documentation +[example] +==== +The following language list reflects the current documentation languages except `en`, this list may change in the future. +[source,shell] +.... +% cd ~/doc/documentation +% HUGO_DISABLELANGUAGES="bd da de el es fr hu it ja ko mn nl pl pt-br ru tr zh-cn zh-tw" make +.... +==== + [[doc-build-rendering-pdf]] === Rendering to pdf diff --git a/documentation/content/en/books/fdp-primer/overview/_index.adoc b/documentation/content/en/books/fdp-primer/overview/_index.adoc --- a/documentation/content/en/books/fdp-primer/overview/_index.adoc +++ b/documentation/content/en/books/fdp-primer/overview/_index.adoc @@ -50,18 +50,11 @@ [.procedure] ==== -. Install these packages. These packages are all of the software needed to edit and build FreeBSD documentation. The Git package is needed to obtain a working copy of the documentation and generate patches with. +. Install these packages. The `docproj` _meta-port_ installs all the applications required to do useful work with the FreeBSD documentation. + [source,shell] .... -# pkg install gohugo python3 git-lite rubygem-asciidoctor rubygem-rouge -.... -+ -. Optional: to generate PDF documentation install `asciidoctor-pdf` -+ -[source,shell] -.... -# pkg install rubygem-asciidoctor-pdf +# pkg install docproj python3 .... + . Install a local working copy of the documentation from the FreeBSD repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The Working Copy]). diff --git a/documentation/content/en/books/fdp-primer/tools/_index.adoc b/documentation/content/en/books/fdp-primer/tools/_index.adoc --- a/documentation/content/en/books/fdp-primer/tools/_index.adoc +++ b/documentation/content/en/books/fdp-primer/tools/_index.adoc @@ -31,7 +31,7 @@ [[tools-required]] == Required Tools -Install `gohugo` and `rubygem-asciidoctor` as shown in crossref:overview[overview,the overview chapter] from the Ports Collection. +Install `docproj` and `python3` as shown in crossref:overview[overview,the overview chapter] from the Ports Collection. These applications are required to do useful work with the FreeBSD documentation. Some further notes on particular components are given below.