https://github.com/ivansanchez/gobble-leafdoc

Gobble plugin to generate Leafdoc (:leaves:doc) documentation.
https://github.com/ivansanchez/gobble-leafdoc

Last synced: 28 days ago
JSON representation

Gobble plugin to generate Leafdoc (:leaves:doc) documentation.

• Host: GitHub
• URL: https://github.com/ivansanchez/gobble-leafdoc
• Owner: IvanSanchez
• Created: 2016-01-14T15:39:22.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-05-24T12:30:40.000Z (over 8 years ago)
• Last Synced: 2024-10-14T15:36:07.218Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 5.86 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gobble-leafdoc

Gobble plugin to generate Leafdoc (🍂doc) documentation.

## Installation

I assume you already know the basics of [Gobble](https://github.com/gobblejs/gobble).

```bash

npm i -D gobble-leafdoc

```

And I also assume that you also have some code with [Leafdoc](https://github.com/IvanSanchez/Leafdoc)-style

documentation on it.

## Usage

In your `gobblefile`, run the `leafdoc` gobble transform with a `output` option, like so:

```javascript

var gobble = require( 'gobble' );

module.exports = gobble( 'src' ).transform( 'leafdoc', {

  output: 'documentation.html'

});

```

Any Leafdoc-specific options can be specified in the transform options, for example:

```javascript

module.exports = gobble( 'src' ).transform( 'leafdoc', {

  output: 'documentation.html',

  templateDir: 'assets/custom-leafdoc-templates',

  leadingCharacter: '@'

});

```

Additionally, the `files` option can be used to order and filter files to be 

parsed with Leafdoc. This is useful when creating subsets of documentation, or

adding some leading/trailing content. The `files` option is a [`minimatch`](https://github.com/isaacs/minimatch)

pattern, or an array of minimatch patterns.

```javascript

module.exports = gobble( 'src' ).transform( 'leafdoc', {

  output: 'documentation.html',

  files: [

     'first-very-important-thing.leafdoc',

     '**/*.js',

     'credits.leafdoc'

  ]

});

```

## License

```

"THE BEER-WARE LICENSE":

 wrote this file. As long as you retain this notice you

can do whatever you want with this stuff. If we meet some day, and you think

this stuff is worth it, you can buy me a beer in return.

```