Appendix A. Examples | FreeBSD Documentation Portal
Description: Example of an article and a book used in the FreeBSD Documentation Project
Keywords: examples,tutorial,AsciiDoctor,Book,Article

# Appendix A. Examples

These examples are not exhaustive - they do not contain all the elements that might be desirable to use, particularly in a document’s front matter. For more examples of AsciiDoctor, examine the AsciiDoc source for this and other documents available in the Git doc repository, or available online starting at https://cgit.freebsd.org/doc/.

## A.1. AsciiDoctor book

Example 1. AsciiDoctor book

    ---
    title: An Example Book
    authors:
      - author: The FreeBSD Documentation Project
    copyright: 1995-2021 The FreeBSD Documentation Project
    releaseinfo: ""
    trademarks: ["general"]
    ---

    = An Example Book
    :doctype: book
    :toc: macro
    :toclevels: 2
    :icons: font
    :xrefstyle: basic
    :relfileprefix: ../
    :outfilesuffix:
    :sectnums:
    :sectnumlevels: 6
    :partnums:
    :chapter-signifier: Chapter
    :part-signifier: Part
    :source-highlighter: rouge
    :experimental:
    :skip-front-matter:
    :book: true
    :pdf: false

    :chapters-path: content/en/books/bookname/

    [abstract]
    Abstract

    Abstract section

    '''

    toc::[]

    :sectnums!:

    include::{chapters-path}preface/_index.adoc[leveloffset=+1]

    :sectnums:

    include::{chapters-path}parti.adoc[lines=7..18]

    include::{chapters-path}chapter-name/_index.adoc[leveloffset=+1]

## A.2. AsciiDoctor article

Example 2. AsciiDoctor article

    ---
    title: An Example Article
    authors:
      - author: Your name and surname
        email: foo@example.com
    trademarks: ["general"]
    ---

    = An Example Article
    :doctype: article
    :toc: macro
    :toclevels: 1
    :icons: font
    :sectnums:
    :sectnumlevels: 6
    :source-highlighter: rouge
    :experimental:

    '''

    toc::[]

    == My First Section

    This is the first section in my article.

    === My First Sub-Section

    This is the first sub-section in my article.

Last modified on: February 18, 2025 by Fernando Apesteguía

Home