show books
The show books command displays all books defined in books.yml, including each book's name, description, and source counts.
Books aggregate static content with dynamically-generated content from EAC commands for MkDocs documentation sites.
Usage: show books
Expected Output:
- Table with columns: Name, Output, Modules, Description, Copy (count), Cmd (count), Inline (count)
- Each row shows a book with its source counts and which modules reference it
Output Sections
A single table with the following columns:
| Column | Description |
|---|---|
| Name | Book identifier |
| Output | Output directory path |
| Modules | Modules that reference this book (first module shown, others as +N) |
| Description | Truncated to 30 characters |
| Copy | Number of copy sources |
| Cmd | Number of command sources |
| Inline | Number of inline sources |
If no books are configured, prints guidance to create .eac/books.yml.
See Also
- serve docs - Serve documentation
- validate books
Tutorials | How-to Guides | Explanation | Reference
You are here: Reference — information-oriented technical descriptions of the system.