989d921f5d
I'm very pleased to announce the release of our new website and documentation using the new toolchain with Hugo and AsciiDoctor. To get more information about the new toolchain please read the FreeBSD Documentation Project Primer[1], Hugo docs[2] and AsciiDoctor docs[3]. Acknowledgment: Benedict Reuschling <bcr@> Glen Barber <gjb@> Hiroki Sato <hrs@> Li-Wen Hsu <lwhsu@> Sean Chittenden <seanc@> The FreeBSD Foundation [1] https://docs.FreeBSD.org/en/books/fdp-primer/ [2] https://gohugo.io/documentation/ [3] https://docs.asciidoctor.org/home/ Approved by: doceng, core
44 lines
1.4 KiB
Text
44 lines
1.4 KiB
Text
---
|
|
title: Chapter 2. Tools
|
|
prev: books/fdp-primer/overview
|
|
next: books/fdp-primer/working-copy
|
|
---
|
|
|
|
[[tools]]
|
|
= Tools
|
|
:doctype: book
|
|
:toc: macro
|
|
:toclevels: 1
|
|
:icons: font
|
|
:sectnums:
|
|
:sectnumlevels: 6
|
|
:source-highlighter: rouge
|
|
:experimental:
|
|
:skip-front-matter:
|
|
:xrefstyle: basic
|
|
:relfileprefix: ../
|
|
:outfilesuffix:
|
|
:sectnumoffset: 2
|
|
|
|
toc::[]
|
|
|
|
Several software tools are used to manage the FreeBSD documentation and render it to different output formats. Some of these tools are required and must be installed before working through the examples in the following chapters. Some are optional, adding capabilities or making the job of creating documentation less demanding.
|
|
|
|
[[tools-required]]
|
|
== Required Tools
|
|
|
|
Install `hugo` and `asciidoctor` as showed in the <<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.
|
|
|
|
[[tools-optional]]
|
|
== Optional Tools
|
|
|
|
These applications are not required, but can make working on the documentation easier or add capabilities.
|
|
|
|
[[tools-optional-software]]
|
|
=== Software
|
|
|
|
Vim (package:editors/vim[])::
|
|
A popular editor for working with AsciiDoctor.
|
|
|
|
Emacs (package:editors/emacs[])::
|
|
Both of these editors include a special mode for editing documents. This mode includes commands to reduce the amount of typing needed, and help reduce the possibility of errors.
|