1.0.2 • Published 8 years ago
filestojson v1.0.2
filestojson
This script will generarate JSON file from content files.
Setup
npm install filestojson --save-devNote: you may have to install Babel globaly to be able to use this lib:
npm install -g babel-cliExamples
What's the application of this? You may ask.
Check the examples of different front-end stacks loading the data and rendering the page:
npm run examplesHow to use
Command line:
filestojson ./path/to/config.jsScript:
import config from './path/to/config.js'
filestojson(config)Configuration
Please refer to the examples/config.js implementation for further example.
Explaining, the config is expected to return an object with the keys:
contentshould be a string for the content folder path, where all content types containing markdown, images and other suff are located;outputshould be a string for the JSON file path that will be generated;includeshould be an array of strings, where the strings are file extensions that will be included;excludeshould be an array of strings, where the strings are file name with the extension that will be ignored;contentTypesshould be an array of object, each object containing key and the content type translation function;
Content types and translations
... TBP ...