
The documentation should have been built prior # to attempting to use the `run` target. # The run target uses hugo's built-in webserver to make the documentation site # available for local browsing. # epub - build EPUB versions of the articles and books (Experimental). # If variable DOC_HTML_ARCHIVE is set, all documents will be # archived/compressed, and only these files will be kept in the public # directory. # html - build HTML versions of the articles and books for # offline use. # Generate the FreeBSD documentation # Copyright (c) 2020-2021, The FreeBSD Documentation Project # Copyright (c) 2020-2021, Sergio Carlavilla # Targets intended for use on the command line # all (default) - generate the books TOC and compile all the documentation # clean - removes generated files # run - serves the built documentation site for local browsing # pdf - build PDF versions of the articles and books. The Makefile defines the build process of the documentation and the website. License of the documentation, shared and website. This image doesn’t need an introduction )


html files that specify how the website looks.Ĭontain tools used to enhance the documentation build.įor example to generate the Table of Contents of the books, etc. Images, security advisories, the pgpkeys, etc.Ĭontain the templates in the form of. This directory is used to store the events, news, press, etc. One directory exists for each available translation of the documentation, for example en and zh-tw.Ĭontain custom data for build the website in TOML format. DirectoryĬontain templates to create new articles, books and webpages.Ĭontain the books, articles and webpages. The documentation is organized into subdirectories below this level, following the Hugo directory structure. These directories contain the documentation and the website. Can I include language or country specific text in my translation? I am the only person working on translating to this language, how do I submit my translation? I have translated some documentation, where do I send it? No one else is translating to my language. How do I find out who else might be translating to the same language? Understanding the Makefile in the Documentation Tree Notes, Tips, Important Information, Warnings, and Examples.
