https://github.com/webcomponents/community
A space for the webcomponents community
https://github.com/webcomponents/community
Last synced: 8 months ago
JSON representation
A space for the webcomponents community
- Host: GitHub
- URL: https://github.com/webcomponents/community
- Owner: webcomponents
- Archived: true
- Created: 2016-09-27T04:26:03.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-09-14T15:54:48.000Z (almost 4 years ago)
- Last Synced: 2025-01-26T08:31:58.250Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.webcomponents.org
- Size: 14.6 MB
- Stars: 26
- Watchers: 10
- Forks: 50
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# webcomponents community
[](https://gitter.im/webcomponents/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://travis-ci.org/webcomponents/community)
# 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.
1. Done! Once it's merged, the site will update with the latest content.
# Development
## Installing
```bash
$ npm install
```
## Running locally
```bash
$ npm start
$ npm run monitor
```
## Tests & linting
```bash
$ 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