Changeset View
Changeset View
Standalone View
Standalone View
documentation/content/en/books/fdp-primer/doc-build/_index.adoc
Show First 20 Lines • Show All 68 Lines • ▼ Show 20 Lines | |||||||||
|Portable Document Format. | |Portable Document Format. | ||||||||
|`epub` | |`epub` | ||||||||
|EPUB | |EPUB | ||||||||
|Electronic Publication. | |Electronic Publication. | ||||||||
ePub file format. | ePub file format. | ||||||||
|=== | |=== | ||||||||
[NOTE] | |||||||||
==== | |||||||||
On macOS and Linux, GNU Make doesn't work due to the syntax difference. | |||||||||
bcr: New sentence, new line. | |||||||||
Done Inline Actionsdifference* ygy: difference*
space before "(" | |||||||||
Users have to install bmake (Berkeley Make) manually. | |||||||||
Done Inline Actions
pauamma_gundo.com: | |||||||||
==== | |||||||||
[[doc-build-rendering-html]] | [[doc-build-rendering-html]] | ||||||||
=== Rendering to html | === Rendering to html | ||||||||
To render the documentation and the website to `html` use one of the following examples. | To render the documentation and the website to `html` use one of the following examples. | ||||||||
[[documentation-build-example]] | [[documentation-build-example]] | ||||||||
.Build the documentation | .Build the documentation | ||||||||
[example] | [example] | ||||||||
▲ Show 20 Lines • Show All 123 Lines • ▼ Show 20 Lines | |||||||||
This will build all English and French books in pdf. | This will build all English and French books in pdf. | ||||||||
==== | ==== | ||||||||
[[doc-build-toolset]] | [[doc-build-toolset]] | ||||||||
== The FreeBSD Documentation Build Toolset | == The FreeBSD Documentation Build Toolset | ||||||||
These are the tools used to build and install the FDP documentation. | These are the tools used to build and install the FDP documentation. | ||||||||
* The primary build tool is man:make[1], specifically Berkeley Make. | * The primary build tool is man:make[1], specifically Berkeley Make. | ||||||||
** Therefore, bmake should be installed and used on macOS and Linux. | |||||||||
Done Inline ActionsNew sentence, new line. bcr: New sentence, new line. | |||||||||
* Hugo | * Hugo | ||||||||
* AsciiDoctor | * AsciiDoctor | ||||||||
* Git | * Git | ||||||||
[[doc-build-makefile]] | [[doc-build-makefile]] | ||||||||
== Understanding the Makefile in the Documentation Tree | == Understanding the Makefile in the Documentation Tree | ||||||||
There are three [.filename]#Makefile# files for building some or all of the documentation project. | There are three [.filename]#Makefile# files for building some or all of the documentation project. | ||||||||
▲ Show 20 Lines • Show All 420 Lines • Show Last 20 Lines |
New sentence, new line.