git: 4f24ed91c2 - main - Add example to generate pdf document in FDP

The branch main has been updated by carlavilla:

URL: https://cgit.FreeBSD.org/doc/commit/?id=4f24ed91c23be2045691a1e916e85f54f6122b70

commit 4f24ed91c23be2045691a1e916e85f54f6122b70
Author:     Sergio Carlavilla Delgado <[email protected]>
AuthorDate: 2021-03-03 20:13:08 +0000
Commit:     Sergio Carlavilla Delgado <[email protected]>
CommitDate: 2021-03-03 20:13:08 +0000

    Add example to generate pdf document in FDP
    
    PR:             253178
    Submitted by:   kib@
---
 .../en/books/fdp-primer/doc-build/chapter.adoc     | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/documentation/content/en/books/fdp-primer/doc-build/chapter.adoc b/documentation/content/en/books/fdp-primer/doc-build/chapter.adoc
index 81aaa9be2d..1bdf595d8d 100644
--- a/documentation/content/en/books/fdp-primer/doc-build/chapter.adoc
+++ b/documentation/content/en/books/fdp-primer/doc-build/chapter.adoc
@@ -48,7 +48,10 @@ Different types of output can be produced from a single AsciiDoc source file.
 |Electronic Publication. ePub file format.
 |===
 
-To render the documentation and the website use one of the following examples.
+[[doc-build-rendering-html]]
+=== Rendering to html
+
+To render the documentation and the website to `html` use one of the following examples.
 
 [[documentation-build-example]]
 .Build the documentation
@@ -83,6 +86,23 @@ To render the documentation and the website use one of the following examples.
 ....
 ====
 
+[[doc-build-rendering-pdf]]
+=== Rendering to pdf
+
+To generate a document in `pdf` format use this command.
+In this example the English Handbook will be used.
+In order to export the document correctly all the extensions should be passed used the `-r` argument.
+
+[[document-pdf-example]]
+.Build the entire documentation project
+[example]
+====
+[source,bash]
+....
+asciidoctor-pdf -r ./shared/lib/man-macro.rb -r ./shared/lib/git-macro.rb -r ./shared/lib/packages-macro.rb -r ./shared/lib/inter-document-references-macro.rb -r ./shared/lib/sectnumoffset-treeprocessor.rb --doctype=book -a skip-front-matter -a pdf-theme=./themes/default-pdf-theme.yml content/en/books/handbook/book.adoc
+....
+====
+
 [[doc-build-toolset]]
 == The FreeBSD Documentation Build Toolset
 
_______________________________________________
[email protected] mailing list
https://lists.freebsd.org/mailman/listinfo/dev-commits-doc-all
To unsubscribe, send any mail to "[email protected]"