Skip to content

Commit 077fe89

Browse files
authored
chore: rebrand repository under open-wc (#125)
1 parent 639c266 commit 077fe89

File tree

8 files changed

+35
-35
lines changed

8 files changed

+35
-35
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
> This project adheres to the Contributor Covenant [code of conduct](./CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
66
7-
First, create a fork of the [web-padawan/api-viewer-element](https://github.com/web-padawan/api-viewer-element) repository by hitting the `fork` button on the GitHub page.
7+
First, create a fork of the [open-wc/api-viewer-element](https://github.com/open-wc/api-viewer-element) repository by hitting the `fork` button on the GitHub page.
88

99
Next, clone your fork onto your computer (replacing YOUR_USERNAME with your actual GitHub username).
1010

@@ -16,7 +16,7 @@ Once cloning is complete, change directory to the repository and add the upstrea
1616

1717
```sh
1818
cd web
19-
git remote add upstream git@github.com:web-padawan/api-viewer-element.git
19+
git remote add upstream git@github.com:open-wc/api-viewer-element.git
2020
```
2121

2222
## Preparing Your Local Environment for Development

LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright © 2019 Serhii Kulykov iamkulykov@gmail.com
3+
Copyright © 2021 open-wc
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
66

README.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -6,45 +6,45 @@ API documentation and live playground for Web Components. Based on [custom eleme
66
<api-viewer src="./custom-elements.json"></api-viewer>
77
```
88

9-
[Documentation →](https://api-viewer-element.netlify.app/docs/guide/intro/)
9+
[Documentation →](https://api-viewer.open-wc.org/docs/guide/intro/)
1010

11-
[Live Demo →](https://api-viewer-element.netlify.app/docs/examples/api-viewer/)
11+
[Live Demo →](https://api-viewer.open-wc.org/docs/examples/api-viewer/)
1212

13-
[<img src="https://raw.githubusercontent.com/web-padawan/api-viewer-element/master/screenshot-docs.png" alt="Screenshot of api-viewer docs" width="800">](https://api-viewer-element.netlify.com/)
13+
[<img src="https://raw.githubusercontent.com/open-wc/api-viewer-element/master/screenshot-docs.png" alt="Screenshot of api-viewer docs" width="800">](https://api-viewer.open-wc.org)
1414

15-
[<img src="https://raw.githubusercontent.com/web-padawan/api-viewer-element/master/screenshot-demo.png" alt="Screenshot of api-viewer demo" width="800">](https://api-viewer-element.netlify.com/)
15+
[<img src="https://raw.githubusercontent.com/open-wc/api-viewer-element/master/screenshot-demo.png" alt="Screenshot of api-viewer demo" width="800">](https://api-viewer.open-wc.org)
1616

1717
## Features
1818

19-
- [API docs viewer](https://api-viewer-element.netlify.app/docs/guide/writing-jsdoc/)
20-
- [Properties](https://api-viewer-element.netlify.app/docs/guide/writing-jsdoc/#properties) - JS properties publicly exposed by the component.
21-
- [Attributes](https://api-viewer-element.netlify.app/docs/guide/writing-jsdoc/#attributes) - HTML attributes (except those that match properties).
22-
- [Events](https://api-viewer-element.netlify.app/docs/guide/writing-jsdoc/#events) - DOM events dispatched by the component.
23-
- [Slots](https://api-viewer-element.netlify.app/docs/guide/writing-jsdoc/#slots) - Default `<slot>` and / or named slots, if any.
24-
- [CSS Custom Properties](https://api-viewer-element.netlify.app/docs/guide/writing-jsdoc/#css-custom-properties) - Styling API of the component.
25-
- [CSS Shadow Parts](https://api-viewer-element.netlify.app/docs/guide/writing-jsdoc/#css-shadow-parts) - Elements that can be styled using `::part()`.
26-
- [Live playground](https://api-viewer-element.netlify.app/docs/guide/using-demo/)
27-
- [Source](https://api-viewer-element.netlify.app/docs/guide/using-demo/#source) - Code snippet matching the rendered component.
28-
- [Knobs](https://api-viewer-element.netlify.app/docs/guide/using-demo/#knobs) - Change properties and slotted content dynamically.
29-
- [Styles](https://api-viewer-element.netlify.app/docs/guide/using-demo/#styles) - Change values of the custom CSS properties.
30-
- [Event log](https://api-viewer-element.netlify.app/docs/guide/using-demo/#events) - Output the events fired by the component.
31-
- [Templates](https://api-viewer-element.netlify.app/docs/api/templates/) - Provide additional HTML to be shown.
19+
- [API docs viewer](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/)
20+
- [Properties](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#properties) - JS properties publicly exposed by the component.
21+
- [Attributes](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#attributes) - HTML attributes (except those that match properties).
22+
- [Events](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#events) - DOM events dispatched by the component.
23+
- [Slots](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#slots) - Default `<slot>` and / or named slots, if any.
24+
- [CSS Custom Properties](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#css-custom-properties) - Styling API of the component.
25+
- [CSS Shadow Parts](https://api-viewer.open-wc.org/docs/guide/writing-jsdoc/#css-shadow-parts) - Elements that can be styled using `::part()`.
26+
- [Live playground](https://api-viewer.open-wc.org/docs/guide/using-demo/)
27+
- [Source](https://api-viewer.open-wc.org/docs/guide/using-demo/#source) - Code snippet matching the rendered component.
28+
- [Knobs](https://api-viewer.open-wc.org/docs/guide/using-demo/#knobs) - Change properties and slotted content dynamically.
29+
- [Styles](https://api-viewer.open-wc.org/docs/guide/using-demo/#styles) - Change values of the custom CSS properties.
30+
- [Event log](https://api-viewer.open-wc.org/docs/guide/using-demo/#events) - Output the events fired by the component.
31+
- [Templates](https://api-viewer.open-wc.org/docs/api/templates/) - Provide additional HTML to be shown.
3232

3333
## Install
3434

3535
```sh
3636
npm install api-viewer-element
3737
```
3838

39-
Check out the [Getting Started](https://api-viewer-element.netlify.app/docs/guide/intro/#usage) guide.
39+
Check out the [Getting Started](https://api-viewer.open-wc.org/docs/guide/intro/#usage) guide.
4040

4141
## Usage
4242

4343
The following web components are available:
4444

45-
- [`<api-viewer>`](https://api-viewer-element.netlify.app/docs/api/elements/#api-viewer-element)
46-
- [`<api-docs>`](https://api-viewer-element.netlify.app/docs/api/elements/#api-docs-element)
47-
- [`<api-demo>`](https://api-viewer-element.netlify.app/docs/api/elements/#api-demo-element)
45+
- [`<api-viewer>`](https://api-viewer.open-wc.org/docs/api/elements/#api-viewer-element)
46+
- [`<api-docs>`](https://api-viewer.open-wc.org/docs/api/elements/#api-docs-element)
47+
- [`<api-demo>`](https://api-viewer.open-wc.org/docs/api/elements/#api-demo-element)
4848

4949
## Contributing
5050

docs/_data/footer.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"children": [
55
{
66
"text": "Help and Feedback",
7-
"href": "https://github.com/web-padawan/api-viewer-element/issues"
7+
"href": "https://github.com/open-wc/api-viewer-element/issues"
88
}
99
]
1010
},
@@ -13,11 +13,11 @@
1313
"children": [
1414
{
1515
"text": "GitHub",
16-
"href": "https://github.com/web-padawan/api-viewer-element"
16+
"href": "https://github.com/open-wc/api-viewer-element"
1717
},
1818
{
1919
"text": "Twitter",
20-
"href": "https://twitter.com/serhiikulykov"
20+
"href": "https://twitter.com/OpenWc"
2121
}
2222
]
2323
},
@@ -26,7 +26,7 @@
2626
"children": [
2727
{
2828
"text": "Contribute",
29-
"href": "https://github.com/web-padawan/api-viewer-element/blob/master/CONTRIBUTING.md"
29+
"href": "https://github.com/open-wc/api-viewer-element/blob/master/CONTRIBUTING.md"
3030
}
3131
]
3232
}

docs/_data/site.cjs

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ module.exports = () => {
88
socialLinks: [
99
{
1010
name: 'GitHub',
11-
url: 'https://github.com/web-padawan/api-viewer-element'
11+
url: 'https://github.com/open-wc/api-viewer-element'
1212
}
1313
],
14-
gitSiteUrl: 'https://github.com/web-padawan/api-viewer-element',
14+
gitSiteUrl: 'https://github.com/open-wc/api-viewer-element',
1515
gitBranch: 'master',
16-
helpUrl: 'https://github.com/web-padawan/api-viewer-element/issues',
16+
helpUrl: 'https://github.com/open-wc/api-viewer-element/issues',
1717
logoAlt: 'API Viewer Element',
1818
iconColorMaskIcon: '#3f93ce',
1919
iconColorMsapplicationTileColor: '#1d3557',

docs/docs/api/templates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ This is useful to create complex UI samples for small components that are typica
7979
### `<template data-target="suffix">`
8080

8181
Use `"suffix"` template to provide HTML to be inserted **after** the web component in the demo.
82-
Note, same as `"prefix"`, this template type can be used to provide [`<style>`](https://github.com/web-padawan/api-viewer-element/issues/45#issuecomment-677458882) tag with CSS to customize the component.
82+
Note, same as `"prefix"`, this template type can be used to provide [`<style>`](https://github.com/open-wc/api-viewer-element/issues/45#issuecomment-677458882) tag with CSS to customize the component.
8383

8484
```html
8585
<api-viewer src="./custom-elements.json">

docs/docs/guide/writing-jsdoc.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,4 +56,4 @@ Elements that can be styled using `::part` need to be documented using `@cssPart
5656
This cover elements with `part` attribute in Shadow DOM, as well as those exposed using `exportparts` attribute.
5757

5858
The parts are currently only used for the documentation, they are not available in the live demo.
59-
Please comment in [this issue](https://github.com/web-padawan/api-viewer-element/issues/42) about CSS Shadow Parts and slots inspector if you are interested.
59+
Please comment in [this issue](https://github.com/open-wc/api-viewer-element/issues/42) about CSS Shadow Parts and slots inspector if you are interested.

package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
"license": "MIT",
1010
"repository": {
1111
"type": "git",
12-
"url": "https://github.com/web-padawan/api-viewer-element.git"
12+
"url": "https://github.com/open-wc/api-viewer-element.git"
1313
},
1414
"bugs": {
15-
"url": "https://github.com/web-padawan/api-viewer-element/issues"
15+
"url": "https://github.com/open-wc/api-viewer-element/issues"
1616
},
1717
"keywords": [
1818
"API",

0 commit comments

Comments
 (0)