npmpackage.info

Gathering detailed insights and metrics for dmd-grunt-jsdoc2md

Other packages similar to dmd-grunt-jsdoc2md

dmd

7.0.7

The default output template for jsdoc-to-markdown

dmd-bitbucket

0.1.11

Plugin for jsdoc2md to produce markdown suitable for bitbucket

dmd-readable

1.2.4

A plugin for dmd and jsdoc-to-markdown to provide more readable docs

grunt-jsdoc-to-markdown

6.0.0

Markdown API documentation generator, good for Github projects

Gathering detailed insights and metrics for dmd-grunt-jsdoc2md

dmd-grunt-jsdoc2md

Plugin for dmd and dmd-grunt-jsdoc2md which provides an api index and more readable docs.

1.1.1

MIT

JavaScript

52,037 2.7

Installations

npm install dmd-grunt-jsdoc2md

Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

0

Total

0

Closed

0

Releases

1.1.1

v1.1.1

Published on 12 Jul 2024

v1.1.0

Published on 02 Jul 2024

release version 1.0.0

v1.0.0

Published on 28 Jul 2021

release version 0.0.8

v0.0.8

Published on 27 Mar 2021

release version 0.0.7

v0.0.7

Published on 27 Mar 2021

release version 0.0.6

v0.0.6

Published on 01 Mar 2021

View all 7 releases

Developer

db-developer

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=16

Typescript Support

No

Node Version

18.20.3

NPM Version

10.7.0 Statistics

3 Stars

104 Commits

1 Watching

2 Branches

1 Contributors

Updated on 12 Jul 2024

Languages

JavaScript (76.69%)

Handlebars (23.31%)

Total Downloads

Cumulative downloads

Total Downloads

52,037

Last day

Compared to previous day

Last week

-72.9%

Compared to previous week

Last month

-77.5%

Compared to previous month

Last year

-87.8%

2,399

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

jsdoc-to-markdown

Versions

dmd-grunt-jsdoc2md

Plugin for dmd and grunt-jsdoc2md which provides an api index and more readable docs.

Changelog

getting started

This guide assumes, you are familiar with the use of npm.

npm install dmd-grunt-jsdoc2md --save-dev

The grunt plugin grunt-jsdoc2md is a dependant of this dmd plugin.

usage

dmd-grunt-jsdoc2md is used, if grunt-jsdoc2md is configured to generate one markdownfile for each sourcefile found within a directory tree.
After all markdowns have been written, all jsdoc metadata of all sourcefiles is enriched, aggregated and passed to dmd-grunt-jsdoc2md for writing an indexfile, which will link (glue) all markdownfiles together.

Imagine the following directory structure for your source files:

--+ src
  + file1.js
  + file2.js
  + subdir1
  |  + subdir1file1.js
  |
  + subdir2
     + subdir2file1.js

Being glued together by a grunt-jsdoc2md configuration like:
(Extract from gruntfile.js)

1  "jsdoc2md": {
2    "target0": {
3      "src":      "src/**/*.js",
4      "dest":     "docs/apidir/",
5      "options": {
6        "index":  {
7          "dest": "docs/api.md"
8        }
9      }
10    }
11  }

Which will produce the following output:

--+ docs
  + api.md         <= this is the index file (s.a.: "docs/api.md")
  |
  + apidir         <= the api markdown root  (s.a.: "docs/apidir")
    + file1.md
    + file2.md
    + subdir1
    |  + subdir1file1.md
    |
    + subdir2
       + subdir2file1.md

The file api.md will hold a listing of all modules listed above. The modules are correctly linked, so you can navigate from the index file to each of the submodules.

No vulnerabilities found.

10

Binary-Artifacts

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

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

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Branch-Protection

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

Score

2.7

/10

Last Scanned on 2024-11-25

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