Skip to content

Commit 637b146

Browse files
committed
Added contribution guide for theme
1 parent 0031b02 commit 637b146

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ If you have a big website dependent on this repository for open-graph images, th
3131

3232
## Contribution
3333

34-
Contributions for a theme is welcome. Please see this [example.html](/dynamic-image/blob/master/examples/index.html) for more detail. It is instructed to create an issue before committing some function changes.
34+
Contributions for a theme is welcome. Please see this [example.html](https://github.com/cachecleanerjeet/dynamic-image/blob/master/examples/index.html) for more detail. It is instructed to create an issue before committing some function changes.
3535

3636
<br><a href="https://www.buymeacoffee.com/tuhinkpal"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=tuhinkpal&button_colour=5F7FFF&font_colour=ffffff&font_family=Cookie&outline_colour=000000&coffee_colour=FFDD00"></a>

examples/index.html

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!--
2+
Create a normal HTML
3+
Use these variables to set the content of the page
4+
- {{title}}: the title of content
5+
- {{content}}: description of content
6+
- {{icon}}: logo of content
7+
- {{base}}: base url (use it if you are requesting assets from the same server) i.e. use {{base}}/css/base.css insted of /css/base.css
8+
Before body part end, please paste this line (See line no 30)
9+
If you are using the {{icon}}, please use this onload function; this will hide the image if an image is empty (See lines no 25 & 26)
10+
Don't use any javascript because SVG is not picking the changes from the DOM
11+
12+
See template-engine for more context. Don't forget to add this to template directory with a cool name (Name: Lowercase, no spaces, no special characters use '-' for spaces)
13+
14+
Thanks for your contribution! 💗
15+
-->
16+
17+
<!DOCTYPE html>
18+
<html lang="en">
19+
<head>
20+
<meta charset="UTF-8" />
21+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
22+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
23+
<title>Example.</title>
24+
</head>
25+
<body onload="'{{icon}}' === '' && document.getElementById('icon').remove()">
26+
<img src="{{icon}}" id="icon" alt="Icon" />
27+
<h1>{{title}}</h1>
28+
<p>{{content}}</p>
29+
</body>
30+
<!-- SVG -->
31+
</body>
32+
</html>

0 commit comments

Comments
 (0)