1.0.2 • Published 4 years ago

@crgeary/carbon-source-filesystem v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

Carbon Source Filesystem

Sources local files for Carbon

Install

npm i @crgeary/carbon-source-filesystem --save

Usage

Add the following configuration to carbon.config.js ...

const path = require('path');

module.exports = {
    plugins: [
        {
            resolve: `@crgeary/carbon-source-filesystem`,
            options: {
                path: path.resolve('content'),
                collection: 'content',
            },
        },
    ],
};

Options

The plugin supports the following configuration options:

KeyTypeDefaultDescription
pathstringAn absolute path to a folder of content
collectionstring'default'A name used to categorise the content

License

MIT