Skip to content

Commit

Permalink
resolves #327 improve epub-chapter-level attribute documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
slonopotamus committed Apr 26, 2020
1 parent 28979d0 commit 95071f5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ Like other converters, Asciidoctor EPUB3 handles this chunking task by automatic

When `doctype` attribute is set to `book`, each top-level section will become a separate ebook "chapter" file.
This includes preface, bibliography, appendix, etc.
This behavior can be configured via `epub-chapter-level` document attribute.

Otherwise, whole document is converted to a single ebook chapter.

Expand Down Expand Up @@ -299,8 +300,9 @@ _Only applies to a chapter document._

|epub-chapter-level
|Specify the section level at which to split the EPUB into separate "chapter" files.
This attribute only affects documents with `:doctype: book`.
The default is to split into chapters at level-1 sections.
This option only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users.
This attribute only affects the internal composition of the EPUB, not the way chapters and sections are displayed to users.
Some readers may be slow if the chapter files are too large, so for large documents with few level-1 headings, one might want to use a chapter level of 2 or 3.

|series-name, series-volume, series-id
Expand Down

0 comments on commit 95071f5

Please sign in to comment.