Skip to content

Commit b1f1bbe

Browse files
mrin9mrin9
committed
updated readme
1 parent 4a21d4e commit b1f1bbe

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

‎docs/README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
### Quickstart (Use from CDN)
3030
Just copy the below script in an html, and open it in a browser !!!
3131
```html
32-
<!doctype html>
32+
<!doctype html> <!-- Important: must specify, else rendering will be effected -->
3333
<html>
3434
<head>
3535
<meta charset="utf-8"> <!-- Important: The Custom element uses utf8 charecters -->
@@ -45,22 +45,22 @@ Just copy the below script in an html, and open it in a browser !!!
4545

4646
### Demo & Examples
4747

48-
- Basic Example [Demo](example1.html)
48+
- Basic Example ([Demo](example1.html))
4949
```html
5050
<rapi-doc
5151
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
5252
> </rapi-doc>
5353
```
5454

55-
- Dark Theme [Demo](example2.html)
55+
- Dark Theme ([Demo](example2.html))
5656
```html
5757
<rapi-doc
5858
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
5959
theme="dark"
6060
> </rapi-doc>
6161
```
6262

63-
- Change Header Color with Dark Theme [Demo](example3.html)
63+
- Change Header Color with Dark Theme ([Demo](example3.html))
6464
```html
6565
<rapi-doc
6666
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
@@ -69,7 +69,7 @@ Just copy the below script in an html, and open it in a browser !!!
6969
> </rapi-doc>
7070
```
7171

72-
- Integrate with any HTML document (Request/Response one below the other) [Demo](example4.html)
72+
- Integrate with any HTML document (Request/Response one below the other) ([Demo](example4.html))
7373
```html
7474
<rapi-doc
7575
spec-url="https://api.apis.guru/v2/specs/bitbucket.org/2.0/swagger.json"
@@ -82,7 +82,7 @@ Just copy the below script in an html, and open it in a browser !!!
8282
> </rapi-doc>
8383
```
8484

85-
- Change Font (you may use local fonts or define your own font) [Demo](example5.html)
85+
- Change Font (you may use local fonts or define your own font) ([Demo](example5.html))
8686
```html
8787
<head>
8888
<link href="https://fonts.googleapis.com/css?family=Varela+Round" rel="stylesheet">
@@ -95,7 +95,7 @@ Just copy the below script in an html, and open it in a browser !!!
9595
</body>
9696
```
9797

98-
- Change Logo [Demo](example6.html)
98+
- Change Logo ([Demo](example6.html))
9999
```html
100100
<body>
101101
<rapi-doc spec-url="https://api.apis.guru/v2/specs/googleapis.com/youtube/v3/swagger.json">
@@ -104,7 +104,7 @@ Just copy the below script in an html, and open it in a browser !!!
104104
</body>
105105
```
106106

107-
- Add HTML content inside the spec [Demo](example7.html)
107+
- Add HTML content inside the spec ([Demo](example7.html))
108108
```html
109109
<body>
110110
<rapi-doc spec-url="https://api.apis.guru/v2/specs/googleapis.com/youtube/v3/swagger.json">
@@ -128,7 +128,7 @@ Just copy the below script in an html, and open it in a browser !!!
128128

129129

130130

131-
- Change Attributes using JavaScript [Demo](example100.html)
131+
- Change Attributes using JavaScript ([Demo](example100.html))
132132

133133
use javascript `Element.setAttribute()` to change the elements attributes and see it reacts to those changes
134134

0 commit comments

Comments
 (0)