https://github.com/sergeylukin/docpad-plugin-bowermount

Docpad plugin that mounts Bower components to web server middleware
https://github.com/sergeylukin/docpad-plugin-bowermount

Last synced: 27 days ago
JSON representation

Docpad plugin that mounts Bower components to web server middleware

• Host: GitHub
• URL: https://github.com/sergeylukin/docpad-plugin-bowermount
• Owner: sergeylukin
• Created: 2013-07-07T18:43:19.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-12-17T02:17:31.000Z (about 10 years ago)
• Last Synced: 2024-12-11T18:50:29.849Z (30 days ago)
• Language: CoffeeScript
• Size: 258 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: History.md

Awesome Lists containing this project

README

        
# bower-mount Plugin for [DocPad](http://docpad.org)

DocPad plugin that auto-mounts bower components and all files specified in

RequireJS `paths` property in web server middleware (currently

only JS components). Best fits for development environment. Assumes that in

production environment JS files are bundled in static files.

It's enabled only in development environment by default

It runs only when docpad initially generates project files. So, if new

bower components are added or new requirejs modules paths are specified

in in `paths` directive, it's recommended to rerun docpad instance.

RequireJS and Bower configurations are a requirement

## Install

Make sure you have installed `bower` and have RequireJS configuration file

installed and set up before you continue.

Install it from you Docpad project:

```

npm install docpad-plugin-bowermount --save-dev

```

Next time you run `docpad run` your bower components will be available via web.

For example, if you installed `jquery` via `bower install jquery` and `docpad

run` creates server accessible via `http://localhost:9778` you can

access `jquery` lib via `http://localhost:9778:/scripts/jquery.js` out of the

box. However if for example you installed `require-handlebars-plugin` then

you'd need to manually specify paths in your requirejs configuration file.

You'd probably want to bundle your components into static

files on build

**RequireJS**: you can set relative path to your

configuration file in `rjsConfig` (default value is `scripts/main.js`)

and if it exists, paths from there will be used to determine components path.

Here is an example of your `docpad.coffee` with this configuration:

```

# ==================

# Environment

environments:

  development:

    plugins:

      bowermount:

        rjsConfig: 'path/to/my/requirejs/config'

```

## History

You can discover the history inside the `History.md` file

## License

Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/)


Copyright © 2013+ [Sergey Lukin](http://sergeylukin.com)