Code Monkey home page Code Monkey logo

grunt-jsdoc-to-markdown's Introduction

view on npm npm module downloads per month Build Status Dependency Status

grunt-jsdoc-to-markdown

A grunt plugin for jsdoc-to-markdown.

Install

$ npm install grunt-jsdoc-to-markdown --save-dev

Usage

Example Gruntfile.js:

"use strict";
module.exports = function(grunt) {

    grunt.initConfig({
        jsdoc2md: {
            oneOutputFile: {
                src: "src/*.js",
                dest: "api/documentation.md"
            },
            separateOutputFilePerInput: {
                files: [
                    { src: "src/jacket.js", dest: "api/jacket.md" },
                    { src: "src/shirt.js", dest: "api/shirt.md" }
                ]
            },
            withOptions: {
                options: {
                    "no-gfm": true
                },
                src: "src/wardrobe.js",
                dest: "api/with-index.md"
            }
        }
    });

    grunt.loadNpmTasks("grunt-jsdoc-to-markdown");
    grunt.registerTask("default", "jsdoc2md");
};

grunt-jsdoc-to-markdown's People

Contributors

75lb avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.