Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    grunt-ngn-docspublic

    grunt-ngn-docs

    A helper method for generating NGN docs.

    Getting Started

    This plugin requires Grunt ~0.4.1

    If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

    npm install grunt-ngn-docs --save-dev

    Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

    grunt.loadNpmTasks('grunt-ngn-docs');

    The "ngn_docs" task

    Overview

    In your project's Gruntfile, add a section named ngn_docs to the data object passed into grunt.initConfig().

    grunt.initConfig({
      ngn_docs: {
        options: {
          // Task-specific options go here.
        },
        your_target: {
          // Target-specific file lists and/or options go here.
        },
      },
    })

    Options

    options.separator

    Type: String Default value: ', '

    A string value that is used to do something with whatever.

    options.punctuation

    Type: String Default value: '.'

    A string value that is used to do something else with whatever else.

    Usage Examples

    Default Options

    In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

    grunt.initConfig({
      ngn_docs: {
        options: {},
        files: {
          'dest/default_options': ['src/testing', 'src/123'],
        },
      },
    })

    Custom Options

    In this example, custom options are used to do something else with whatever else. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!!

    grunt.initConfig({
      ngn_docs: {
        options: {
          separator: '',
          punctuation: ' !!!',
        },
        files: {
          'dest/default_options': ['src/testing', 'src/123'],
        },
      },
    })

    Contributing

    In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

    Release History

    (Nothing yet)

    Keywords

    none

    install

    npm i grunt-ngn-docs

    Downloadsweekly downloads

    3

    version

    0.1.0

    license

    none

    repository

    githubgithub

    last publish

    collaborators

    • avatar