https://github.com/futbotism/stylgyver-webpack

A plugin for parsing angular projects and extracting meta info for displaying into a styleguide
https://github.com/futbotism/stylgyver-webpack

angular documentation tools typescript

Last synced: about 2 months ago
JSON representation

A plugin for parsing angular projects and extracting meta info for displaying into a styleguide

• Host: GitHub
• URL: https://github.com/futbotism/stylgyver-webpack
• Owner: futbotism
• Created: 2017-11-12T12:29:25.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-02-21T11:32:02.000Z (over 8 years ago)
• Last Synced: 2026-03-20T00:45:34.374Z (3 months ago)
• Topics: angular, documentation, tools, typescript
• Language: JavaScript
• Size: 92.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Stylgyver!

Stylgyver is a plugin for webpack that generates documentation from your shared angular folder

[example and docs here!](https://futbotism.github.io/stylgyver-ng/)

## Install

`npm install stylgyver-webpack --save-dev`

## Import

`const StylgyverPlugin = require('../stylgyver-webpack');`

## Configure

```javascript

new StylgyverPlugin({

    outputPath: './src/app/styleguide/meta.json',

    sourceOptions: [{

        parseType: 'component',

        name: 'components',

        path: 'src/app/shared/components'

      },{

        name: 'models',

        parseType: 'model',

        path: 'src/app/shared/models',

        addMetaToArray: 'true'

      },{

        name: 'pipes',

        parseType: 'pipe',

        path: 'src/app/shared/pipes',

        addMetaToArray: 'true'

      },{

        name: 'directives',

        parseType: 'directive',

        path: 'src/app/shared/directives',

        addMetaToArray: 'true'

      }

    ]

  })

  ```