Gathering detailed insights and metrics for grunt-mdoc
Gathering detailed insights and metrics for grunt-mdoc
Grunt plugin generating HTML documentation from Markdown sources using mdoc
Installations
npm install grunt-mdocDeveloper Guide
BETA
Typescript
No
Module System
N/A
Min. Node Version
>=6
Node Version
10.16.3
NPM Version
6.9.0
Releases
6
Languages
1
JavaScript
JavaScript (100%)
Developer
prantlf
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
1 Stars
64 Commits
1 Forks
2 Watchers
3 Branches
2 Contributors
Updated on Sep 24, 2019
Maintainers
1
Package Meta Information
Latest Version
1.0.3
Package Id
grunt-mdoc@1.0.3
Unpacked Size
7.09 kB
Size
3.22 kB
File Count
5
NPM Version
6.9.0
Node Version
10.16.3
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
grunt-mdoc
This module provides a grunt multi-task generating HTML documentation from Markdown sources using mdoc.
Installation
You need node >= 0.10, npm and grunt >= 0.4 installed and your project build managed by a Gruntfile with the necessary modules listed in package.json. If you haven't used Grunt before, be sure to check out the [Getting Started] guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
1$ npm install grunt-mdoc --save-dev
Input
Store your written articles in to a folder (input), specify a target folder for the generated HTML pages and optionally a title page (index.md):
1input/ 2 overview.md 3 ... 4output/ 5 assets_/ 6 index.html 7 overview.html 8 ... 9index.md 10Gruntfile.js
Configuration
Add the mdoc entry with the mdoc task configuration to the options of the
grunt.initConfig method:
1grunt.initConfig({
2 mdoc: {
3 dist: {
4 src: 'input',
5 dest: 'output',
6 options: {
7 indexContentPath: 'index.md',
8 baseTitle: 'My Project Documentation'
9 }
10 }
11 }
12});The supported options are:
src: (required) the source folder with files in the Markdown format; sub-folders will be searched recursivelydest: (required) the target folder for the HTML filesindexContent: (optional) HTML markup to put to the top of the index page; it takes precedence overindexContentPathindexContentPath: (optional) Markdown source file for the index pagebaseTitle: (optional) the title text for the HTML page head- ... refer to the mdoc documentation for all the available options
Then, load the plugin:
1grunt.loadNpmTasks('grunt-mdoc');
Build
Call the mdoc task:
1$ grunt mdoc
or integrate it to your build sequence in Gruntfile.js:
1grunt.registerTask('default', ['mdoc', ...]);
Notes
The generated index.html file should be opened from a HTTP server. The
sidebar that shows the documentation index is loaded by AJAX, which does
not work when the HTML page is opened from the file:// scheme.
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Release History
- 2018-04-27 v1.0.0 Dropped support of Node.js 4
- 2017-02-24 v0.3.1 Update dependencies
- 2016-26-08 v0.3.0 Upgrade to Grunt 1.x
- 2016-03-05 v0.2.2 Update dependencies, improve build testing
- 2015-01-31 v0.1.1 Initial release
License
Copyright (c) 2015-2019 Ferdinand Prantl
Licensed under the MIT license.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 0/13 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- 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
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 17 are checked with a SAST tool
Reason
43 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-h6ch-v84p-w6p9
- Warn: Project is vulnerable to: GHSA-phwq-j96m-2c2q
- Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
- Warn: Project is vulnerable to: GHSA-957j-59c2-j692
- Warn: Project is vulnerable to: GHSA-m5pj-vjjf-4m3h
- Warn: Project is vulnerable to: GHSA-j383-35pm-c5h4
- Warn: Project is vulnerable to: GHSA-rm36-94g8-835r
- Warn: Project is vulnerable to: GHSA-w457-6q6x-cgp9
- Warn: Project is vulnerable to: GHSA-62gr-4qp9-h98f
- Warn: Project is vulnerable to: GHSA-f52g-6jhx-586p
- Warn: Project is vulnerable to: GHSA-2cf5-4w76-r9qv
- Warn: Project is vulnerable to: GHSA-3cqr-58rm-57f8
- Warn: Project is vulnerable to: GHSA-g9r4-xpmj-mj65
- Warn: Project is vulnerable to: GHSA-q2c6-c6pm-g3gh
- Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
- Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
- Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
- Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
- Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
- Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-4xcv-9jjx-gfj3
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
- Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
- Warn: Project is vulnerable to: GHSA-h6mq-3cj6-h738
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
1.7
/10
Last Scanned on 2025-07-07
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