eduardolundgren / webcomponents.org

WebComponents.org site

WebComponents.org

Install

This site is made with Jekyll, a static generator in Ruby, and the best way to install it is via RubyGems:

$ gem install jekyll

Once Jekyll is installed, you just need to clone the project:

$ git clone [e-mail]:WebComponentsOrg/webcomponents.org.git

Usage

Jekyll has three basic options used in this project:

To generate the site and run it in a server, which can be viewed at http://localhost:4000, run:

$ jekyll serve

To regenerate the site as you edit and save files, run:

$ jekyll serve --watch

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

$ jekyll build

Tasks

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

To install it and all the other dependencies, run:

$ npm install

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.

Team

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

| | | | | --- | --- | --- | --- | --- | --- | --- John Doe | John Doe | John Doe | John Doe | John Doe | John Doe

Contributing

See the Contributing guide.

License

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