Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

metalsmith-prefixoid

1.0.3 • Public • Published

metalsmith-prefixoid npm version Build Status

This is a metalsmith plugin which prefixizes internal urls.

Let prefix be /pref. In this case plugin will work by following way:

  • http://example.com/sub/dir/ -> http://example.com/sub/dir/ (doesn't change)
  • ../relative/path -> ../relative/path (doesn't change)
  • another/relative/path -> another/relative/path (doesn't change)
  • /internal/absolute/path -> /pref/internal/absolute/path (prefixizes)

Also it can replace all relative paths by absolute if there is configure parameter convert_relatives is set to true.

Usage

var prefixoid = require('metalsmith-prefixoid');
    ...
  .use(prefixoid({
    prefix: '/base_url'
  }))

Array of options is supported.

.use(prefixoid([{...}, {...}, {...}]))

It's also possible to set defaults for each item in array. Properties of object from first argument will be defaults for every array item of second argument:

.use(prefixoid({...}, [{...}, {...}, {...}]))

Options

One of meta or prefix is required, all other are optional:

  • meta: 'some.name.space' - will take prefix from metalsmith.metadata().some.name.space
  • prefix: '/base/url' - take prefix from config.
  • tag: 'a' - (default: 'a') transforms only elements of this tag.
  • attr: 'href' - (default: 'href') attr with URL to modify.
  • convert_relatives: false - (default: false) converts relatives to absolutes, works if tranfrom is undefined.
  • pattern: ['*.md'] - (default: ['**/*.md', '**/*.html', '**/*.htm']) process only satisfied files.

Styling:

  • span_currents: true - will replace <a>-links to current page with <span> elements.
  • links_class: 'a-link' - css class of <a>-links.
  • spans_class: 'span-link' - css class of spans which were links.
  • all_links_class: 'all-link' - css class of every link processed with plugin.

Very optional options:

  • is_current: function(current_url, url) - will recognize if link is current. By default it takes equality to one of options:
    • current_url
    • current_url + '/'
    • current_url + '/index.html'
  • transform: function(url)->url - Check if url must be transformed and transforms url.
  • transform_file_path - bool or function(path)->path. Default false. If true it replaces .html with / to recognize if path is current. It does not affect path field. If function str -> str is passed then prefixoid converts path with it.

Config example:

...
  .use(react_templates({
    directory: 'templates',
    baseFile: 'base.html',
    nonStatic: true
  }))
  .use(prefixoid({
      meta: 'site.base_path',
    },
    [{
      span_currents: true,
      links_class: 'omich-link_a',
      spans_class: 'omich-link_current',
      all_links_class: 'omich-link'
     },{
      selector: 'link',
      attr: 'href'
     },{
      selector: 'script',
      attr: 'src'
     }
    ]))
  .build(function(err) {
    if (err) {
      throw err;
    }
  });

License

The MIT License (MIT)

Copyright (c) 2015 Chivorotkiv chivorotkiv@omich.net

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

install

npm i metalsmith-prefixoid

Downloadsweekly downloads

46

version

1.0.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability