https://github.com/db-developer/dmd-grunt-jsdoc2md
Plugin for dmd and dmd-grunt-jsdoc2md which provides an api index and more readable docs.
https://github.com/db-developer/dmd-grunt-jsdoc2md
dmd javascript jsdoc markdown md
Last synced: 4 months ago
JSON representation
Plugin for dmd and dmd-grunt-jsdoc2md which provides an api index and more readable docs.
- Host: GitHub
- URL: https://github.com/db-developer/dmd-grunt-jsdoc2md
- Owner: db-developer
- License: mit
- Created: 2020-12-22T21:31:09.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-12T15:34:04.000Z (over 1 year ago)
- Last Synced: 2025-05-15T09:08:41.695Z (6 months ago)
- Topics: dmd, javascript, jsdoc, markdown, md
- Language: JavaScript
- Homepage: https://www.slashlib.org/?page_id=508
- Size: 75.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# dmd-grunt-jsdoc2md
Plugin for dmd and grunt-jsdoc2md which provides an api index and more readable docs.
[](https://www.npmjs.com/package/dmd-grunt-jsdoc2md)
[](https://opensource.org/licenses/MIT)
[](https://gruntjs.com/)
[](https://libraries.io/)
## content ##
* [Getting started guide](#getting-started)
* [Usage](#usage)
[Changelog](CHANGELOG.md)
## getting started ##
This guide assumes, you are familiar with the use of [npm](https://npmjs.com "Homepage 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)
```json
"jsdoc2md": {
"target0": {
"src": "src/**/*.js",
"dest": "docs/apidir/",
"options": {
"index": {
"dest": "docs/api.md"
}
}
}
}
```
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.