awoo-pretty

    1.1.2 • Public • Published

    awoo-pretty

    nice pretty links for awoo

    npm version code style: standard

    Installation

    npm install awoo-pretty

    Usage example

    const awoo = require('awoo')
    const plugin = require('awoo-pretty')
     
    // enter our main function:
    // the main function should be an async function so that
    // it automatically returns a promise
    awoo(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:

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

    Maintainers

    License

    MIT (see LICENSE document)

    Keywords

    Install

    npm i awoo-pretty

    DownloadsWeekly Downloads

    2

    Version

    1.1.2

    License

    MIT

    Last publish

    Collaborators

    • oceanseraph