1.0.0 • Published 9 years ago

laravel-elixir-ngdocs v1.0.0

Weekly downloads
3
License
MIT
Repository
github
Last release
9 years ago

Laravel-elixir-3-ngdocs

This package contains the Elixir task to compile ngDocs. These package can be free used for everyone how they like.

What does this package do for you

NgDocs is a way to document your angularJS application. This packages compiles the comment blocks to the ngDocs within the laravel-elixir bundle

How to use

The only thing you have to do to is follow these 3 steps First install the package into your project

npm install --save-dev

After the installation is done you require the package in your gulpfile

require('laravel-elixir-3-ngdocs');

In the elixir function you define the task like you always do

mix.ngdocs();

These method use the default options. You can override the default options by providing a options object

mix.ngdocs({
    html5Mode: true,
    startPage: '/starting-page',
    title: "Laravel Elixir NgDocs",
    image: "",
    imageLink: "",
    titleLink: "",
    scripts: [],
    styles: []
    })
    

Enjoy :)