docpad-plugin-browserifydocs

Browserify Documents for DocPad

Browserify your documents by adding the browserify: true meta data

Install

docpad install browserifydocs

Usage

Create a JavaScript file with the browserify option:

---
browserify: true
---

var mypackage = require('mypackage');

Configure

Defaults

The default configuration for this plugin is the equivalant of adding the following browserify options to your DocPad configuration file:

plugins:
	browserifydocs:
		debug: false

Require

Make certain files available from outside the bundle by using require:

---
browserify:
	require:
		'./vendor/angular/angular.js':
			expose: 'angular'
---

var angular = require('angular');

Ignore

Prevent a module or file from showing up in the output bundle by using ignore:

---
browserify:
	ignore: ['jquery']
---

var jquery = require('jquery');

External

Prevent a file or module from being loaded into the current bundle, instead referencing from another bundle, by using external.

---
browserify:
	external: ['jquery']
---

var jquery = require('jquery');

Exclude

Prevent a module name or file from showing up in the output bundle by using exclude.

---
browserify:
	exclude: ['jquery']
---

var jquery = require('jquery');

History

Discover the change history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

• Benjamin Lupton [e-mail] (https://github.com/balupton)
• Rob Loach [e-mail] (https://github.com/RobLoach)

Sponsors

No sponsors yet! Will you be the first?

Contributors

These amazing people have contributed code to this project:

• Benjamin Lupton [e-mail] — view contributions
• Rob Loach [e-mail] — view contributions

Become a contributor!

License

Licensed under the incredibly permissive MIT license

Copyright © 2014+ Bevry Pty Ltd [e-mail] (http://bevry.me)