https://github.com/zandaqo/dmd-plugin-gitbook

https://github.com/zandaqo/dmd-plugin-gitbook

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/zandaqo/dmd-plugin-gitbook
• Owner: zandaqo
• Created: 2017-05-04T07:13:13.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-21T16:02:08.000Z (about 9 years ago)
• Last Synced: 2025-04-09T06:16:48.936Z (about 1 year ago)
• Language: HTML
• Size: 2.93 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# dmd-plugin-gitbook

[![view on npm](http://img.shields.io/npm/v/dmd-plugin-gitbook.svg)](https://www.npmjs.org/package/dmd-plugin-gitbook)

Plugin for [jsdoc2md](https://github.com/jsdoc2md/jsdoc-to-markdown) to produce markdown suitable for Gitbook.

## Install

```

$ npm install dmd-plugin-gitbook --save-dev

```

## Use

Pass the plugin name to `jsdoc2md` or `dmd` when generating your docs:

```

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

```