npmpackage.info

grunt-jsdoc-to-markdown

Markdown API documentation generator

6.0.0

MIT

JavaScript

Installations

npm install grunt-jsdoc-to-markdown

Pull Requests

Open

0

Total

2

Closed

1

Merged

1

Issues

Open

0

Total

13

Closed

13

Releases

v3.0.0

Published on 06 Mar 2017

v2.0.0

Published on 11 Oct 2016

View all 2 releases

Developer

jsdoc2md

Developer Guide

BETA

Module System

Unable to determine the module system for this package.

Min. Node Version

>=14

Typescript Support

No

Node Version

15.7.0

NPM Version

7.4.3 Statistics

16 Stars

67 Commits

4 Forks

2 Watching

1 Branches

2 Contributors

Updated on 01 Sept 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

432,174

Last day

-64.6%

164

Compared to previous day

Last week

-40.8%

3,566

Compared to previous week

Last month

229.4%

12,766

Compared to previous month

Last year

-19.6%

57,155

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

grunt-jsdoc-to-markdown

A grunt plugin for jsdoc-to-markdown. Accepts the same options as the render method.

Install

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

Usage

Example Gruntfile.js:

1'use strict'
2module.exports = function (grunt) {
3  grunt.initConfig({
4    jsdoc2md: {
5      oneOutputFile: {
6        src: 'src/*.js',
7        dest: 'api/documentation.md'
8      },
9      separateOutputFilePerInput: {
10        files: [
11          { src: 'src/jacket.js', dest: 'api/jacket.md' },
12          { src: 'src/shirt.js', dest: 'api/shirt.md' }
13        ]
14      },
15      withOptions: {
16        options: {
17          'no-gfm': true
18        },
19        src: 'src/wardrobe.js',
20        dest: 'api/with-index.md'
21      }
22    }
23  })
24
25  grunt.loadNpmTasks('grunt-jsdoc-to-markdown')
26  grunt.registerTask('default', 'jsdoc2md')
27}

Tested by test-runner.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to grunt-jsdoc-to-markdown

jsdoc

4.0.4

An API documentation generator for JavaScript.

grunt-jsdoc

2.4.1

Integrates jsdoc3 generation into your Grunt build

eslint-plugin-jsdoc

50.6.0

JSDoc linting rules for ESLint.

jsdoc-type-pratt-parser

4.1.0

[![Npm Package](https://badgen.net/npm/v/jsdoc-type-pratt-parser)](https://www.npmjs.com/package/jsdoc-type-pratt-parser) [![Test Status](https://github.com/jsdoc-type-pratt-parser/jsdoc-type-pratt-parser/actions/workflows/test.yml/badge.svg?branch=main)]

grunt-jsdoc-to-markdown

Installations

Pull Requests

0

2

1

1

Issues

0

13

13

Releases

Developer

jsdoc2md

Developer Guide

>=14

No

15.7.0

7.4.3

Statistics

Languages

Total Downloads

432,174

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

grunt-jsdoc-to-markdown

Install

Usage

10

10

0

0

0

0

0

0

0

0

1.7

/10

Other packages similar to grunt-jsdoc-to-markdown