Skip to content

Turn a collection of HTML pages into books. Adjusts links and image locations.

License

Notifications You must be signed in to change notification settings

fidian/metalsmith-bookify-html

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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, default book.html

    Where the file will be written.

  • indexFile String or String[], 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, default body

    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>, default index.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.

About

Turn a collection of HTML pages into books. Adjusts links and image locations.

Resources

License

Stars

Watchers

Forks

Packages