Installations
npm install dmd-grunt-jsdoc2mdReleases
Developer
Developer Guide
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
0%
11
Compared to previous day
Last week
-72.9%
13
Compared to previous week
Last month
-77.5%
95
Compared to previous month
Last year
-87.8%
2,399
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
dmd-grunt-jsdoc2md
Plugin for dmd and grunt-jsdoc2md which provides an api index and more readable docs.
content
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.
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
Found 0/30 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v1.1.1 not signed: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/165211829
- Warn: release artifact v1.1.0 not signed: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/163561350
- Warn: release artifact v1.0.0 not signed: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/46889068
- Warn: release artifact v0.0.8 not signed: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/40571903
- Warn: release artifact v0.0.7 not signed: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/40571435
- Warn: release artifact v1.1.1 does not have provenance: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/165211829
- Warn: release artifact v1.1.0 does not have provenance: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/163561350
- Warn: release artifact v1.0.0 does not have provenance: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/46889068
- Warn: release artifact v0.0.8 does not have provenance: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/40571903
- Warn: release artifact v0.0.7 does not have provenance: https://api.github.com/repos/db-developer/dmd-grunt-jsdoc2md/releases/40571435
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
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 MoreOther packages similar to dmd-grunt-jsdoc2md
dmd
The default output template for jsdoc-to-markdown
dmd-bitbucket
Plugin for jsdoc2md to produce markdown suitable for bitbucket
dmd-readable
A plugin for dmd and jsdoc-to-markdown to provide more readable docs
grunt-jsdoc-to-markdown
Markdown API documentation generator, good for Github projects