metalsmith-bookify-html
v1.5.0
Published
Turn a collection of separate HTML files into one. Adjusts links between pages and updates image elements.
Downloads
14
Readme
metalsmith-bookify-html
Combine several HTML files into one. Updates links to images and changes links to pages to use anchors.
Installation
npm install metalsmith-bookify-html
Usage
var bookifyHtml = require('metalsmith-bookify-html');
new Metalsmith(__dirname)
.use(bookifyHtml(options))
.build()
options
Object
dest
String
, defaultbook.html
Where the file will be written.
indexFile
String
orString[]
, default["index.html", "index.md"]
When a link is to a folder, the plugin will automatically attempt to scan for an index file with these names. Even though the name could end in
.md
, it must be an HTML file.metadata
Object
, default{}
Sets these metadata properties on the destination file. Useful for template systems, file processing filters, etc.
selector
String
, defaultbody
The CSS selector to use for finding the content to append. The target element will not be included, just its
innerHTML
.src
String|Array<String>
, defaultindex.html
Files to be included in the book as a starting point. All local links within the book are scanned as well.
License
MIT License, see LICENSE for details.