...
',\n },\n {\n content: 'Chapter 2',\n title: '...
',\n },\n];\n\nconst css = `\n table {\n border: 3px double #ccc;\n margin-left: auto;\n margin-right: auto;\n padding: 0.5em;\n }\n`;\n\nconst options = {\n showContents: true,\n coverType: 'image', // Possible types are 'image' and 'text'\n};\n\nconst epub = new Epub({\n metadata,\n sections,\n // Optional\n css,\n options,\n resources,\n});\n```\n\n### Regarding Metadata\n\n- `cover` should be the filename of an image - recommendation is 600x800, 600x900, or similar\n- `fileAs` is the sortable version of the `author`, which is usually by last name\n- `genre` becomes the main subject in the final Epub\n- `language` is the short *ISO* language name (`en`, `fr`, `de` etc)\n- `published` is the data published - note the *year-month-day* format\n- `series` and `sequence` are not recognised by many readers (it sets the properties used by *Calibre*)\n- `showContents` (default is `true`) lets you suppress the contents page\n- `tags` also become subjects in the final Epub\n\n### Regarding Sections\n\n| PARAMETER | PURPOSE | DEFAULT |\n| ------------------- | -------------------------------- | ------- |\n| title (required) | Table of contents entry text | |\n| content (required) | HTML body text | |\n| excludeFromContents | Hide from contents/navigation | `false` |\n| isFrontMatter | Place before the contents page | `false` |\n| overrideFilename | Section filename inside the Epub | |\n\n### Including Resources\n\nResources include images and mp3s.\n\nIn the example above:\n\n``` javascript\nconst resources = [{\n data: await readFile('../example/hat.png'),\n name: '../example/hat.png',\n}];\n```\n\nThis part of the metadata is an array of objects which provide a data buffer and the name of the file.\n\nThese resources are automatically added into the Epub when it is generated. They always go in an `resources` folder internally. As they all go into the same folder they *should have unique filenames*. Duplicates are removed.\n\nTo include the resources in your content the HTML should refer to this internal folder rather than the original source folder, so for example `![](\"../resources/hat.png\")
` in the above example.\n\n### Changing the Styling\n\nYou can inject basic CSS into your book. This allows you to override the basic styling to change how it looks.\nYou should use this sparingly - there is inconsistent CSS support across ereader devices/software.\n\nModify the `css` parameter of `createEpub`.\n\n```javascript\nconst css = `p { text-indent: 0; } p+p { text-indent: 0.75em; }`);\nconst epub = new Epub({\n css,\n resources,\n metadata,\n sections,\n});\n```\n\n### Advanced Options\n\nYou can also modify the book with advanced options.\n\n| PARAMETER | PURPOSE | DEFAULT |\n| ------------------- | --------------------------------- | --------- |\n| showContents | Whether or not to include the TOC | `true` |\n| coverType | Is the cover 'image' or 'text'? | `'image'` |\n\n```javascript\nconst options = {\n showContents: true, // Whether or not to include the TOC page (default: true)\n coverType: 'image', // Possible types are 'image' and 'text' (default: 'image')\n};\n\nconst epub = createEpub({\n metadata,\n options,\n sections,\n});\n```\n\n### Generating Output\n\nHaving defined your document generating an Epub is as simple as:\n\n``` javascript\nawait epub.write(folder, filename);\n```\n\n## A Full Example\n\nIn the top folder (the one containing the `package.json` file) run the following:\n\n``` javascript\npnpm run example\n```\n\nThis runs in [the `example` folder](./example) using the code in [`example/example.js`](./example/example.js) to generate a final Epub.\n\n## Changelog\n\n- [You can view the change log here.](./CHANGELOG.md)\n\n## Previous Work & Credits\n\n* [Original](https://github.com/kcartlidge/nodepub)\n* [Original Fork with Pug Templates](https://github.com/fholzer/nodepub).\n* [Nodepub3 with MP3](https://gitee.com/taolt/nodepub3/tree/master)\n","readmeFilename":"README.md"}