2.8.0 • Published 4 years ago

docpad-plugin-browserifydocs v2.8.0

Weekly downloads
5
License
MIT
Repository
github
Last release
4 years ago

Browserify Documents for DocPad

Browserify your documents by adding the browserify: true meta data

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');

Install this DocPad plugin by entering docpad install browserifydocs into your terminal.

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

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

These amazing people are maintaining this project:

No sponsors yet! Will you be the first?

These amazing people have contributed code to this project:

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

Unless stated otherwise all works are:

and licensed under: