https://github.com/webcomponents/webcomponents.github.io
WebComponents.org is where community-members document Web Components best practices
https://github.com/webcomponents/webcomponents.github.io
Last synced: 8 months ago
JSON representation
WebComponents.org is where community-members document Web Components best practices
- Host: GitHub
- URL: https://github.com/webcomponents/webcomponents.github.io
- Owner: webcomponents
- Archived: true
- Created: 2013-08-19T13:36:14.000Z (almost 13 years ago)
- Default Branch: site
- Last Pushed: 2017-01-11T02:05:30.000Z (over 9 years ago)
- Last Synced: 2024-10-02T06:42:30.201Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://webcomponents.org
- Size: 81 MB
- Stars: 734
- Watchers: 80
- Forks: 119
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# [webcomponents.github.io](http://webcomponents.github.io/)
[](https://travis-ci.org/webcomponents/webcomponents.github.io)
[](https://david-dm.org/webcomponents/webcomponents.github.io)
[](https://david-dm.org/webcomponents/webcomponents.github.io#info=devDependencies)
> Deprecated. Please see [webcomponents/webcomponents.org](https://github.com/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](https://github.com/bevry/docpad), a static generator in [Node](http://nodejs.org/), and the best way to install it is via [npm](http://npmjs.org/).
First, you need to clone the project:
```sh
$ git clone https://github.com/webcomponents/webcomponents.github.io
```
Then go to the folder and install all dependencies:
```sh
$ 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:
```sh
$ 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:
```sh
$ npm run build
```
To generate and send the output to `gh-pages` branch, run:
```sh
$ npm run deploy
```
## Tasks
We use [Grunt](http://gruntjs.com/), a task-runner in [Node](http://nodejs.org/), to automate things.
To install it and all the other dependencies, run:
```sh
$ npm install -g grunt-cli
```
To check performance regressions, run:
```sh
$ grunt pagespeed
```
> P.S.: You'll need to [generate a PageSpeed API key](https://developers.google.com/speed/docs/insights/v1/getting_started#auth) and defined it as an environment variable.
## Browser Support
We do care about it.
| 
| 
| 
| 
| 
| 
|
|:---:|:---:|:---:|:---:|:---:|:---:|
| Latest ✔ | Latest ✔ | Latest ✔ | IE 9+ ✔ | Latest ✔ | Latest ✔ |
## Team
WebComponents.org is maintained by these people and a bunch of awesome [contributors](https://github.com/webcomponents/webcomponents.github.io/graphs/contributors).
[](https://github.com/zenorocha) | [](https://github.com/addyosmani) | [](https://github.com/ebidel) | [](https://github.com/brizabueno) | [](https://github.com/jkomoros)
--- | --- | --- | --- | ---
[Zeno Rocha](https://github.com/zenorocha) | [Addy Osmani](https://github.com/addyosmani) | [Eric Bidelman](https://github.com/ebidel) | [Briza Bueno](https://github.com/brizabueno) | [Alex Komoroske](https://github.com/jkomoros)
[](https://github.com/eduardolundgren) | [](https://github.com/PascalPrecht) | [](https://github.com/bernarddeluna) | [](https://github.com/sindresorhus) | [](https://github.com/robdodson)
--- | --- | --- | --- | ---
[Eduardo L.](https://github.com/eduardolundgren) | [Pascal Precht](https://github.com/PascalPrecht) | [Bernard De L.](https://github.com/bernarddeluna) | [Sindre Sorhus](https://github.com/sindresorhus) | [Rob Dodson](https://github.com/robdodson)
## Contributing
See the [Contributing guide](https://github.com/webcomponents/webcomponents.github.io/blob/site/CONTRIBUTING.md).
## License
Source code is available under [MIT](http://webcomponentsorg.mit-license.org) license and content is under [Creative Commons BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/deed.en_US).