mayocat / mayocat.js

An optional script to help building mayocat themes

Mayocat.js

Mayocat.js is an optional script that can help building Mayocat themes.

Installation

To use Mayocat.js on your theme you can install it with Bower:

bower install mayocat.js

And add the minified file to your HTML:

<script src="/bower_components/mayocat.js/dist/mayocat.min.js"></script>

Or you can do install it manually, downloading the file and putting it somewhere in your theme folder.

Contributing

Setup

Clone the project, then install all the dependencies:

git clone https://github.com/mayocat/mayocat.js.git
cd mayocat.js
npm install

Compilation

To build the project:

npm run build

The above command runs bower update -d before each build to make sure all your dependencies are up-to-date, if you want to get rid of this step, just run:

gulp build

Releases

The releases are automated through a simple command. Say you want to create a 1.2.3 release, just run:

gulp release --ver 1.2.3

This will run a final build, edit the configuration files, commit them, add a new tag, and push the master branch to the origin remote.

mayocat.js's Issues

Add the "resource" helper