https://github.com/maxkoryukov/dmd-gitbook

Plugin for jsdoc2md to produce markdown suitable for gitbook.
https://github.com/maxkoryukov/dmd-gitbook

dmd dmd-plugin gitbook jsdoc jsdoc2md markdown plugin

Last synced: 4 months ago
JSON representation

Plugin for jsdoc2md to produce markdown suitable for gitbook.

• Host: GitHub
• URL: https://github.com/maxkoryukov/dmd-gitbook
• Owner: maxkoryukov
• License: mit
• Created: 2017-02-19T23:56:32.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-02-23T21:10:50.000Z (over 9 years ago)
• Last Synced: 2025-10-10T20:58:09.732Z (8 months ago)
• Topics: dmd, dmd-plugin, gitbook, jsdoc, jsdoc2md, markdown, plugin
• Language: JavaScript
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# dmd-gitbook

[![Tips](http://img.shields.io/gittip/maxkoryukov.png)](https://www.gittip.com/maxkoryukov/)

[![Build Status](https://travis-ci.org/maxkoryukov/dmd-gitbook.svg?branch=master)](https://travis-ci.org/maxkoryukov/dmd-gitbook)

[![npm version](https://img.shields.io/npm/v/dmd-gitbook.svg)](https://www.npmjs.com/package/dmd-gitbook)

[![npm downloads](https://img.shields.io/npm/dm/dmd-gitbook.svg)](https://www.npmjs.com/package/dmd-gitbook)

[![codebeat badge](https://codebeat.co/badges/fca005f3-4e1e-4f9a-978e-bf51aa941259)](https://codebeat.co/projects/github-com-maxkoryukov-dmd-gitbook)

[![bitHound Overall Score](https://www.bithound.io/github/maxkoryukov/dmd-gitbook/badges/score.svg)](https://www.bithound.io/github/maxkoryukov/dmd-gitbook)

[![bitHound Dependencies](https://www.bithound.io/github/maxkoryukov/dmd-gitbook/badges/dependencies.svg)](https://www.bithound.io/github/maxkoryukov/dmd-gitbook/master/dependencies/npm)

[![codecov](https://codecov.io/gh/maxkoryukov/dmd-gitbook/branch/master/graph/badge.svg)](https://codecov.io/gh/maxkoryukov/dmd-gitbook)

Plugin for jsdoc2md to produce markdown suitable for gitbook.

To use a plug-in in your project, first install it as a devDependency:

```

$ npm install dmd-gitbook --save-dev

```

Then pass the plug-in name to `jsdoc2md` or `dmd`:

```

$ jsdoc2md --plugin dmd-gitbook lib/*.js

```

## License

Please, read the [`LICENSE`](LICENSE) file in the root of the repository (or downloaded package).