Skip to content
This repository has been archived by the owner on Nov 25, 2022. It is now read-only.

Latest commit

 

History

History
53 lines (44 loc) · 1.34 KB

README.md

File metadata and controls

53 lines (44 loc) · 1.34 KB
Raw

webcomponents community

Join the chat at https://gitter.im/webcomponents/community Travis

Adding or modifying content

  1. Decide what the content type is:
  • Evergreen pages such as Polyfills, Specifications should be modified in [/static]
  • Posts such as articles/podcasts/presentations should be added to [/documents]
  1. Send a PR with the changes.
  2. Done! Once it's merged, the site will update with the latest content.

Development

Installing

$ npm install

Running locally

$ npm start
$ npm run monitor

Tests & linting

$ npm run lint
$ npm test

API

Content

GET /content/:path

Returns blob of markdown/html content.

Static

GET /static/:file

Returns static file. Static files do not appear in /resources lists and do not contain any docpad metadata.

List

GET /resources/[:type]

Returns a list of n resource excerpts of specified type. type is optional. Query params:

  • offset - offset in results to return. Default: 0
  • limit - number of results to return. Default: 10