Git Product home page Git Product logo

jsdoc-docset-generator's Introduction

JSDoc DocSet Generator

Generates a DocSet from JSDoc documentation. This DocSet can be used with the Dasp App.

Configuration

{
  "docSetRoot": "/path/to/docset/output",
  "docSetName": "MyDocSetJs",
  "docSetIdentifier": "MyDocSet",
  "docSetPlatformFamily": "MyDocSet",
  "icon": "/path/to/my/icon.png",
  "documentation": "/path/to/jsdoc/output"
}

Usage

var JsdocDocsetGenerator = require('jsdoc-docset-generator'),

var generator = new JsdocDocsetGenerator(
    {
      'documentation': '/path/to/jsdoc/output',
      'docSetRoot': '/path/to/docset/output',
      'docSetName': 'MyDocSetJs',
      'docSetIdentifier': 'MyDocSet',
      'docSetPlatformFamily': 'MyDocSet',
      'icon': '/path/to/my/icon.png'
    });

generator
    .populate(require('/path/to/docset.json'));

jsdoc-docset-generator's People

Contributors

theasta avatar

Stargazers

 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.