Giter VIP home page Giter VIP logo

gulp-apidoc-to-markdown's Introduction

Build Status

#gulp-apidoc-markdown

Getting Started

Install the module with: npm install gulp-apidoc-to-markdown .

Apidoc files need to be generated first, namely "api_data.json" and "api_project.json" .

The example below is based on your sources being written to the "app" folder, and your standard apidoc files being written to the "public/apidoc" folder

var apidoc = require('gulp-apidoc'),
    apidoc2md = require('gulp-apidoc-to-markdown');

gulp.task('apidoc-to-markdown-only', function(){
    apidoc2md.generate(process.cwd() + "/public/apidoc", process.cwd() + "/public/apidoc/apidoc.md");
});

gulp.task('apidoc', function(){
    apidoc({
        src: "app/",
        dest: "public/apidoc/",
        debug: false,
    },done);
});

gulp.task('apidoc-md', ['apidoc', 'apidoc-to-markdown-only']);

Documentation

(Coming soon)

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 Gulp.

License

Copyright (c) 2015 Adam Gavish
Licensed under the MIT license.

gulp-apidoc-to-markdown's People

Contributors

agavish avatar oferitz 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.