Add an option to hide the Table of content

readme.md

@@ -67,6 +67,8 @@ epub.render()
     Title of the table of contents. If not specified, will fallback to `Table Of Contents`.
 -   `appendChapterTitles`:
     Automatically append the chapter title at the beginning of each contents. You can disable that by specifying `false`.
+-   `hideToC`:
+    Hide the Table of content in the generated EPUB (optional, default to `false`).
 -   `customOpfTemplatePath`:
     Optional. For advanced customizations: absolute path to an OPF template.
 -   `customNcxTocTemplatePath`:

src/index.ts

@@ -272,6 +272,7 @@ export interface EpubOptions {
   author?: Array<string> | string;
   tocTitle?: string;
   appendChapterTitles?: boolean;
+  hideToC?: boolean;
   date?: string;
   lang?: string;
   css?: string;
@@ -326,6 +327,7 @@ export class EPub {
   author: Array<string>;
   tocTitle: string;
   appendChapterTitles: boolean;
+  showToC: boolean;
   date: string;
   lang: string;
   css: string | null;
@@ -367,6 +369,7 @@ export class EPub {
     }
     this.tocTitle = options.tocTitle ?? "Table Of Contents";
     this.appendChapterTitles = options.appendChapterTitles ?? true;
+    this.showToC = options.hideToC !== true;
     this.date = options.date ?? new Date().toISOString();
     this.lang = options.lang ?? "en";
     this.css = options.css ?? null;

templates/epub2/content.opf.ejs

@@ -50,7 +50,7 @@
             <% } %>
         <% }) %>
         <% if (locals.cover) { %><itemref idref="cover"/><% } %>
-        <itemref idref="toc" />
+        <% if (locals.showToC) { %><itemref idref="toc" /><% } %>
         <% content.forEach(function(content, index){ %>
             <% if(!content.beforeToc && !content.excludeFromToc){ %>
                 <itemref idref="content_<%= index %>_<%= content.id %>"/>
@@ -59,6 +59,6 @@
     </spine>
     <guide>
         <% if (locals.cover) { %><reference type="cover" title="Cover" href="cover.xhtml"/><% } %>
-        <reference type="text" title="Table of Content" href="toc.xhtml"/>
+        <% if (locals.showToC) { %><reference type="text" title="Table of Content" href="toc.xhtml"/><% } %>
     </guide>
 </package>

templates/epub3/content.opf.ejs

@@ -66,7 +66,7 @@
             <% } %>
         <% }) %>
         <% if (locals.cover) { %><itemref idref="cover"/><% } %>
-        <itemref idref="toc" />
+        <% if (locals.showToC) { %><itemref idref="toc" /><% } %>
         <% content.forEach(function(content, index){ %>
             <% if(!content.beforeToc && !content.excludeFromToc){ %>
                 <itemref idref="content_<%= index %>_<%= content.id %>"/>
@@ -75,6 +75,6 @@
     </spine>
     <guide>
         <% if (locals.cover) { %><reference type="cover" title="Cover" href="cover.xhtml"/><% } %>
-        <reference type="text" title="Table of Content" href="toc.xhtml"/>
+        <% if (locals.showToC) { %><reference type="text" title="Table of Content" href="toc.xhtml"/><% } %>
     </guide>
 </package>

templates/toc.ncx.ejs

@@ -26,12 +26,14 @@
             <% } %>
         <% }) %>
 
+        <% if (locals.showToC) { %>
         <navPoint id="toc" playOrder="<%= _index++ %>" class="chapter">
             <navLabel>
                 <text><%= tocTitle %></text>
             </navLabel>
             <content src="toc.xhtml"/>
         </navPoint>
+        <% } %>
 
         <% content.forEach(function(content, index){ %>
             <% if(!content.excludeFromToc && !content.beforeToc){ %>

tests/epub.spec.ts

@@ -31,6 +31,14 @@ it("Ebook without cover > generate v3", async () => {
   assert.strictEqual(await runTestOn("book-no-cover-v3"), true);
 }).timeout(12000);
 
+it("Ebook without ToC > generate v2", async () => {
+  assert.strictEqual(await runTestOn("book-no-toc-v2"), true);
+}).timeout(12000);
+
+it("Ebook without ToC > generate v3", async () => {
+  assert.strictEqual(await runTestOn("book-no-toc-v3"), true);
+}).timeout(12000);
+
 it("HTML Page > generate v2", async () => {
   assert.strictEqual(await runTestOn("article-v2"), true);
 }).timeout(12000);