Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/docpad/docpad-plugin-browserifydocs
Browserify your documents by adding the `browserify: true` meta data
https://github.com/docpad/docpad-plugin-browserifydocs
docpad-plugin
Last synced: 3 months ago
JSON representation
Browserify your documents by adding the `browserify: true` meta data
- Host: GitHub
- URL: https://github.com/docpad/docpad-plugin-browserifydocs
- Owner: docpad
- License: other
- Created: 2014-01-27T19:06:23.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-01-07T11:57:01.000Z (about 1 year ago)
- Last Synced: 2024-10-31T16:04:51.523Z (3 months ago)
- Topics: docpad-plugin
- Language: JavaScript
- Size: 338 KB
- Stars: 3
- Watchers: 16
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Browserify Documents for DocPad
Browserify your documents by adding the `browserify: true` meta data
## Usage
Create a JavaScript file with the *browserify* option:
``` javascript
---
browserify: true
---
var mypackage = require('mypackage');
```
## Configure
### Defaults
The default configuration for this plugin is the equivalant of adding the following [browserify options](https://github.com/substack/node-browserify#bbundleopts-cb) to your [DocPad configuration file](http://docpad.org/docs/config):
``` coffee
plugins:
browserifydocs:
debug: false
```
### Require
Make certain files available from outside the bundle by using [require](https://github.com/substack/node-browserify#brequirefile-opts):
``` javascript
---
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](https://github.com/substack/node-browserify#bignorefile):
``` javascript
---
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](https://github.com/substack/node-browserify#bexternalfile).
``` javascript
---
browserify:
external: ['jquery']
---
var jquery = require('jquery');
```
### Exclude
Prevent a module name or file from showing up in the output bundle by using [exclude](https://github.com/substack/node-browserify#bexcludefile).
``` javascript
---
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?
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:
- Copyright © 2014+ Bevry Pty Ltd
and licensed under: