https://github.com/jdalton/docdown

A simple JSDoc to Markdown generator.
https://github.com/jdalton/docdown

docdown javascript jsdoc markdown

Last synced: about 16 hours ago
JSON representation

A simple JSDoc to Markdown generator.

• Host: GitHub
• URL: https://github.com/jdalton/docdown
• Owner: jdalton
• License: mit
• Created: 2011-06-02T03:24:16.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2021-05-06T19:30:26.000Z (almost 4 years ago)
• Last Synced: 2024-10-24T16:51:11.873Z (4 months ago)
• Topics: docdown, javascript, jsdoc, markdown
• Language: JavaScript
• Homepage:
• Size: 227 KB
• Stars: 202
• Watchers: 11
• Forks: 26
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - docdown

README

        
# docdown v0.7.3

A simple JSDoc to Markdown documentation generator.

## Usage

```js

var docdown = require('docdown');

var markdown = docdown({

  'path': filepath,

  'url': 'https://github.com/username/project/blob/master/my.js'

});

```