laravel-mix-shins v0.1.0

Laravel Mix Shins

This extension provides support for generating API documentation from Open Api Specification yaml file.

It uses:

1. widdershins
2. shins

Usage

First, install the extension.

npm install laravel-mix-shins

Then, require it within your webpack.mix.js file, like so:

let mix = require('laravel-mix');
require('laravel-mix-shins');

mix.shins('docs/api.yml', 'docs', {
    saveMarkdown: true,
    shins: {},
    widdershins: {
        tocSummary: true,
        language_tabs: [
            {shell: 'SHELL'},
        ]
    }
});

Options

• widdershins - all available options for widdershins
• shins - all available options for shins
• saveMarkdown - should be saved generated markdown file (default true)