Skip to content

docpad/docpad-plugin-browserifydocs

Repository files navigation

Browserify Documents for DocPad

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

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

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

History

Discover the release 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:

Sponsors

No sponsors yet! Will you be the first?

GitHub Sponsors donate button Patreon donate button Flattr donate button Liberapay donate button Buy Me A Coffee donate button Open Collective donate button crypto donate button PayPal donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

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

License

Unless stated otherwise all works are:

and licensed under: