https://github.com/makotot/assemble-index-json

assemble index generator
https://github.com/makotot/assemble-index-json

Last synced: 4 months ago
JSON representation

assemble index generator

• Host: GitHub
• URL: https://github.com/makotot/assemble-index-json
• Owner: makotot
• Created: 2015-07-06T09:24:24.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-09T07:39:12.000Z (over 9 years ago)
• Last Synced: 2025-03-06T05:37:37.239Z (4 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/assemble-index-json
• Size: 180 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# assemble-index-json

[![npm version](https://img.shields.io/npm/v/assemble-index-json.svg?style=flat-square)](https://github.com/makotot/assemble-index-json)

[![travis](http://img.shields.io/travis/makotot/assemble-index-json.svg?style=flat-square)](https://github.com/makotot/assemble-index-json)

[![dependencies](http://img.shields.io/david/makotot/assemble-index-json.svg?style=flat-square)](https://github.com/makotot/assemble-index-json)

[![devDependencies](http://img.shields.io/david/dev/makotot/assemble-index-json.svg?style=flat-square)](https://github.com/makotot/assemble-index-json)

[![License](http://img.shields.io/npm/l/assemble-index-json.svg?style=flat-square)](https://github.com/makotot/assemble-index-json)

> assemble index generator

## Install

```

$ npm i --save-dev assemble-index-json

```

## Register

```

assemble: {

  options: {

    plugins: ['assemble-index-json']

  }

}

```

## options

```

assemble: {

  options: {

    plugins: ['assemble-index-json'],

    indexJson: {

      jsonPath: './index.json',

      availables: [

        'title'

      ],

      excludes: ['./src/pages/index.hbs']

    }

  }

}

```

### jsonPath

Path to a json is generated from this plugin.

### availables

Data list that you want to retrieve from page data.

### excludes

Glob patterns of src files that you want to exclude from index.

## License

MIT