@weh/pretty

@weh/pretty

nice pretty links for weh

Installation

npm install @weh/pretty

Usage example

const weh = require('@weh/weh')
const plugin = require('@weh/pretty')

// enter our main function:
// the main function should be an async function so that
// it automatically returns a promise
weh(async site => {
  // we use the plugin
  site.use(plugin)
  // ...and initiate the build process
  return site
})

Filters

By default, pretty operates on all HTML files (files that end with .html). This can be changed easily by using a custom filter. A filter is a function that takes a file and returns a boolean that describes whether that file should have pretty enabled or not. A custom filter can look like this:

function myCustomFilter (file, options, files) {
  return file.path.includes('my-dir/')
}

This filter only matches HTML files that are located in the my-dir directory.

To use the filter, just pass it into the plugin options:

weh(async site => {
  site.use(pretty, {filter: myCustomFilter})
  return site
})

Maintainers

• Olivia Hugger <[e-mail]>

License

MIT (see LICENSE document)