WebComponents.org is where community-members document Web Components best practices
JavaScript CSS HTML
Switch branches/tags
Nothing to show
Latest commit 84fcc7a Jan 10, 2017 @samuelli samuelli committed on GitHub Update README.md
Permalink
Failed to load latest commit information.
src
.editorconfig
.gitignore
.travis.yml
CONTRIBUTING.md
Gruntfile.js
README.md
authors.js
docpad.js
package.json

README.md

webcomponents.github.io

Build Status Dependency Status DevDependencies Status

Deprecated. Please see webcomponents/webcomponents.org.

WebComponents.org is a place for web component authors to discuss and share best practices, patterns and learning resources.

Setup

This site is made with DocPad, a static generator in Node, and the best way to install it is via npm.

First, you need to clone the project:

$ git clone https://github.com/webcomponents/webcomponents.github.io

Then go to the folder and install all dependencies:

$ cd webcomponents.github.io
$ npm install

Now you're good to go!

Usage

DocPad has three basic options used in this project:

To regenerate the site as you edit and save files, which can be viewed at http://localhost:9778, run:

$ npm run watch

To generate a static version of the site, that is ready to upload to a server (it will create a folder called out), run:

$ npm run build

To generate and send the output to gh-pages branch, run:

$ npm run deploy

Tasks

We use Grunt, a task-runner in Node, to automate things.

To install it and all the other dependencies, run:

$ npm install -g grunt-cli

To check performance regressions, run:

$ grunt pagespeed

P.S.: You'll need to generate a PageSpeed API key and defined it as an environment variable.

Browser Support

We do care about it.

Chrome logo Edge logo Firefox logo Internet Explorer logo Opera logo Safari logo
Latest ✔ Latest ✔ Latest ✔ IE 9+ ✔ Latest ✔ Latest ✔

Team

WebComponents.org is maintained by these people and a bunch of awesome contributors.

Zeno Addy Eric Briza Alex
Zeno Rocha Addy Osmani Eric Bidelman Briza Bueno Alex Komoroske
Eduardo Pascal Bernard Sindre Rob
Eduardo L. Pascal Precht Bernard De L. Sindre Sorhus Rob Dodson

Contributing

See the Contributing guide.

License

Source code is available under MIT license and content is under Creative Commons BY-SA 3.0.