From owner-dev-commits-doc-all@freebsd.org Wed Mar 3 20:15:02 2021 Return-Path: Delivered-To: dev-commits-doc-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id B21BB54FCBF for ; Wed, 3 Mar 2021 20:15:02 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4DrQGG4XR5z3H60; Wed, 3 Mar 2021 20:15:02 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 8A9337A69; Wed, 3 Mar 2021 20:15:02 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 123KF2WA046380; Wed, 3 Mar 2021 20:15:02 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 123KF2Tj046379; Wed, 3 Mar 2021 20:15:02 GMT (envelope-from git) Date: Wed, 3 Mar 2021 20:15:02 GMT Message-Id: <202103032015.123KF2Tj046379@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Sergio Carlavilla Delgado Subject: git: 4f24ed91c2 - main - Add example to generate pdf document in FDP MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: carlavilla X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 4f24ed91c23be2045691a1e916e85f54f6122b70 Auto-Submitted: auto-generated X-BeenThere: dev-commits-doc-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the doc repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 03 Mar 2021 20:15:02 -0000 The branch main has been updated by carlavilla: URL: https://cgit.FreeBSD.org/doc/commit/?id=4f24ed91c23be2045691a1e916e85f54f6122b70 commit 4f24ed91c23be2045691a1e916e85f54f6122b70 Author: Sergio Carlavilla Delgado AuthorDate: 2021-03-03 20:13:08 +0000 Commit: Sergio Carlavilla Delgado 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