Template: template-book

This template provides a boilerplate repository for books in Duckietown.

What to change

These are the fields you must update to create your book.

Placeholders in dtproject/self.yaml

This file contains information about the book. Replace the following placeholders with the appropriate information.

• <BOOK_NAME_HERE>: Replace it with the name of the book (e.g., book-opmanual-duckiebot);
• <YOUR_FULL_NAME>: Replace with your name in the format "First Last";
• <YOUR_EMAIL_ADDRESS>: Replace with your email address;
• <BOOK_DESCRIPTION_HERE>: Replace with a one-line description of the book;

Structure in src/_toc.yml

Use the instructions here to learn how to structure your book using the Table of Contents file _toc.yml. A simple example is already provided by this template. Adapt it to your needs.

Logo in src/logo.png

There is a default logo in src/logo.png. This is the book's logo, change it with something that reflects the scope of your book. Transparent PNGs are recommended.

Build

You can build this book by running the command,

dts docs build