npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@vamship/grunt-typedoc

v1.7.13

Published

Grunt task to generate type docs for a given project

Downloads

9

Readme

@vamship/grunt-typedoc

Grunt task to generate documentation from typescript source files.

This is a grunt wrapper for the typedoc tool that allows the generation of documentation from typescript sources files using the grunt task runner.

API Documentation

API documentation can be found here.

Motivation

Generating documentation from source code is a good practice to have, and most programming languages have extensive support for this features typedoc is the generally accepted tool for documentation generation from typescript.

However, there are no grunt task runners available for typedoc that are compatible with newer versions of typedoc (>2.7.x). The existing grunt plugin (grunt-typedoc)[https://github.com/TypeStrong/grunt-typedoc] has not been updated in many years, and still references typedoc v0.4.1.

This library is an attempt to fill this gap, and uses the typedoc api (does not invoke binary directly) to generate documentation from typescript sources.

Installation

This library can be installed using npm:

npm install @vamship/grunt-typedoc

Usage

Using the task

Once installed, the task has to be loaded by using the following line in Gruntfile.js:

grunt.loadNpmTasks('@vamship/grunt-typedoc');

The task can be configured as follows:

grunt.initConfig({
    typedoc: {
        build: {
            options: {
                module: 'commonjs',
                out: './docs',
                name: 'my-project',
                target: 'ES5'
            },
            src: ['./src/**/*']
        }
    }
});

All options passed to the task are passed directly to typedoc, except for the following properties:

  1. out: This property defines the target directory to which all the generated documentation will be written.
  2. json: This property defines a path to a JSON file that to which unformatted (non html) documentation will be written.

The options object must specify at least one of out or json properties.