isabella232 / cdnjs-importer

Easier way to add your libraries in cdnjs.

$ cdnjs-importer

Easy way to import a library into CDNJS.

Installation

You can install the package globally and use it as command line tool:

$ npm i -g [email protected]

Then, run cdnjs-importer --help and see what the CLI tool can do.

$ cdnjs-importer --help
Usage: cdnjs-importer [options]

Options:
  -g, --git-url <git-url>  Your library git url.
  -p, --path <path>        The path to your cdnjs local repository.
  -h, --help               Displays this help.
  -v, --version            Displays version information.

Examples:
  cdnjs-importer -g [email protected]:IonicaBizau/gh.js.git # adds gh.js to cdnjs
  cdnjs-importer -g ... -p path/to/cdnjs

The default cdnjs repository location is in ~/cdnjs

Documentation can be found at https://github.com/cdnjs/cdnjs-importer

Example

Here is an example how to use this package as library. To install it locally, as library, you can do that using npm:

$ npm i cdnjs-importer

// Dependencies
var CdnJsImporter = require("cdnjs-importer")
  , Path = require("path")
  ;

// Test adding CaiuSS
CdnJsImporter({
    cdnjs: Path.resolve(__dirname, "../../cdnjs")
  , debug: true
  , libs: [
        "[email protected]:IonicaBizau/CaiuSS.git"
    ]
}, function (res) {
    console.log(res);
});

Documentation

For full API reference, see the DOCUMENTATION.md file.

How to contribute

Have an idea? Found a bug? See how to contribute.

Press Highlights

None yet. If you wrote or found an article about this project, add it in this section. 📝

License

KINDLY © Ionică Bizău–The LICENSE file contains a copy of the license.