Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing documentation #1

Open
klarkc opened this issue Dec 27, 2015 · 3 comments
Open

Missing documentation #1

klarkc opened this issue Dec 27, 2015 · 3 comments

Comments

@klarkc
Copy link

klarkc commented Dec 27, 2015

Hello, where I can find documentation for this plugin?

@alanrodas
Copy link
Owner

There is no proper documentation yet, and unfortunately do to personal reasons I do not foresee any docs for this in the short time.

You can take a look at Laravel Elixir: https://laravel.com/docs/5.0/elixir Potion is actually a fork of this project, so most of the documentation work, just change the "elixir" function by the "potion" one.
The main changes to the original project are to satisfy the project structure used in a CakePHP 2.x application. So for example:

´´´
potion(function(mix) {
mix.coffee();
});
´´´

will compile the coffescript file at App/Assets/coffee into /webroot/js/app.js. You can pass the same argument that you will do in elixir in order to configure additional behavior.

If in doubt, you can always refer to the code, or send me an email and I will respond ASAP.

@Oxicode
Copy link

Oxicode commented May 9, 2016

+1 more documentation

@pfuri
Copy link

pfuri commented Oct 6, 2016

I was hoping for docs too, instead I wrote a new npm module that wraps around elixir, rather than modifying it and provides identical elixir usage for CakePHP and automatic setup with a "postinstall" script... and it has docs!

cakephp-elixir

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants