Skip to content

Commit 49cac4e

Browse files
peterbenoitpeterbenoit
committed
Enhance SEO and metadata in API and index documentation for better visibility and user experience
1 parent 1f8fa73 commit 49cac4e

2 files changed

Lines changed: 182 additions & 44 deletions

File tree

‎docs/api.html‎

Lines changed: 95 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,95 @@
22
<html lang="en">
33
<head>
44
<meta charset="UTF-8" />
5-
<meta
6-
name="viewport"
7-
content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"
8-
/>
9-
<title>API Reference - RepoWidget</title>
10-
<meta name="description" content="Comprehensive API reference for the RepoWidget library" />
11-
<link
12-
rel="stylesheet"
13-
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css"
14-
/>
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
6+
7+
<!-- Primary Meta Tags -->
8+
<title>API Reference - RepoWidget Documentation</title>
9+
<meta name="title" content="API Reference - RepoWidget Documentation" />
10+
<meta name="description" content="Comprehensive API reference for the RepoWidget library. Complete documentation with examples, parameters, and configuration options." />
11+
<meta name="keywords" content="repowidget api, github widget documentation, javascript api reference, repository widget guide" />
12+
<meta name="author" content="Peter Benoit" />
13+
<meta name="robots" content="index, follow" />
14+
<meta name="language" content="English" />
15+
<meta name="revisit-after" content="7 days" />
16+
17+
<!-- Canonical URL -->
18+
<link rel="canonical" href="https://peterbenoit.github.io/RepoWidget/api.html" />
19+
20+
<!-- Open Graph / Facebook -->
21+
<meta property="og:type" content="website" />
22+
<meta property="og:url" content="https://peterbenoit.github.io/RepoWidget/api.html" />
23+
<meta property="og:title" content="API Reference - RepoWidget Documentation" />
24+
<meta property="og:description" content="Comprehensive API reference for the RepoWidget library. Complete documentation with examples, parameters, and configuration options." />
25+
<meta property="og:image" content="https://peterbenoit.github.io/RepoWidget/assets/images/og-image.png" />
26+
<meta property="og:image:width" content="1200" />
27+
<meta property="og:image:height" content="630" />
28+
<meta property="og:site_name" content="RepoWidget" />
29+
<meta property="og:locale" content="en_US" />
30+
31+
<!-- Twitter -->
32+
<meta property="twitter:card" content="summary_large_image" />
33+
<meta property="twitter:url" content="https://peterbenoit.github.io/RepoWidget/api.html" />
34+
<meta property="twitter:title" content="API Reference - RepoWidget Documentation" />
35+
<meta property="twitter:description" content="Comprehensive API reference for the RepoWidget library. Complete documentation with examples, parameters, and configuration options." />
36+
<meta property="twitter:image" content="https://peterbenoit.github.io/RepoWidget/assets/images/og-image.png" />
37+
<meta property="twitter:creator" content="@peterbenoit" />
38+
39+
<!-- Favicons -->
40+
<link rel="icon" type="image/x-icon" href="assets/images/favicon.ico" />
41+
<link rel="icon" type="image/png" sizes="16x16" href="assets/images/favicon-16x16.png" />
42+
<link rel="icon" type="image/png" sizes="32x32" href="assets/images/favicon-32x32.png" />
43+
<link rel="apple-touch-icon" sizes="180x180" href="assets/images/apple-touch-icon.png" />
44+
<link rel="manifest" href="assets/manifest.json" />
45+
<meta name="theme-color" content="#0366d6" />
46+
<meta name="msapplication-TileColor" content="#0366d6" />
47+
<meta name="msapplication-config" content="assets/browserconfig.xml" />
48+
49+
<!-- DNS Prefetch -->
50+
<link rel="dns-prefetch" href="//cdnjs.cloudflare.com" />
51+
<link rel="dns-prefetch" href="//api.github.com" />
52+
53+
<!-- Preconnect -->
54+
<link rel="preconnect" href="https://cdnjs.cloudflare.com" crossorigin />
55+
56+
<!-- CSS Resources -->
57+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css" integrity="sha512-xh6O/CkQoPOWDdYTDqeRdPCVd1SpvCA9XXcUnZS2FmJNp1coAFzvtCN9BmamE+4aHK8yyUHUSCcJHgXloTyT2A==" crossorigin="anonymous" referrerpolicy="no-referrer" />
1558
<link rel="stylesheet" href="assets/css/styles.css" />
16-
<link
17-
rel="stylesheet"
18-
href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/themes/prism.min.css"
19-
/>
20-
<link
21-
rel="stylesheet"
22-
href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/plugins/toolbar/prism-toolbar.min.css"
23-
/>
24-
<link rel="icon" href="assets/images/favicon.ico" type="image/x-icon" />
59+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/themes/prism.min.css" integrity="sha512-tN7Ec6zAFaVSG3TpNAKtk4DOHNpSwKHxxrsiw4GHKESGPs5njn/0sMCUMl2svV4wo4BK/rCP7juYz+zx+l6oeQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
60+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/plugins/toolbar/prism-toolbar.min.css" integrity="sha512-Dqf5X5AAp5789NYyWhUzDmjz6qmJ8k8pDGiQnlM6kAtjvzGlYgJ5vBSGTD2ZHJQNcaUFLI7EhDbN8XdJsKJKEQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
61+
62+
<!-- Breadcrumb Navigation -->
63+
<link rel="up" href="./" title="RepoWidget Home" />
64+
65+
<!-- Structured Data -->
66+
<script type="application/ld+json">
67+
{
68+
"@context": "https://schema.org",
69+
"@type": "TechArticle",
70+
"headline": "RepoWidget API Reference",
71+
"description": "Comprehensive API reference for the RepoWidget library with examples and configuration options",
72+
"author": {
73+
"@type": "Person",
74+
"name": "Peter Benoit",
75+
"url": "https://www.uiguy.dev"
76+
},
77+
"datePublished": "2025-01-01",
78+
"dateModified": "2025-01-01",
79+
"mainEntityOfPage": {
80+
"@type": "WebPage",
81+
"@id": "https://peterbenoit.github.io/RepoWidget/api.html"
82+
},
83+
"publisher": {
84+
"@type": "Person",
85+
"name": "Peter Benoit"
86+
},
87+
"about": {
88+
"@type": "SoftwareApplication",
89+
"name": "RepoWidget"
90+
}
91+
}
92+
</script>
93+
2594
<style>
2695
/* Additional styles specific to the API reference page */
2796
.api-sidebar {
@@ -287,6 +356,7 @@
287356
</style>
288357
</head>
289358
<body>
359+
<a href="https://www.uiguy.dev" rel="author" class="seo-author-link">Peter Benoit</a>
290360
<header class="header">
291361
<div class="container">
292362
<nav class="nav">
@@ -448,7 +518,9 @@ <h3 class="parameter-name">username</h3>
448518
<span class="type-label">String</span>
449519
<span class="required-label">Required</span>
450520
</p>
451-
<p>The GitHub username whose repositories will be displayed.</p>
521+
<p class="parameter-description">
522+
The GitHub username whose repositories will be displayed.
523+
</p>
452524
<div class="code-example">
453525
<pre
454526
class="code-block language-javascript"
@@ -472,7 +544,7 @@ <h3 class="parameter-name">containerId</h3>
472544
<span class="type-label">String</span>
473545
<span class="required-label">Required</span>
474546
</p>
475-
<p>
547+
<p class="parameter-description">
476548
The ID of the HTML element where the repositories will be
477549
rendered.
478550
</p>
@@ -823,7 +895,7 @@ <h3>Resources</h3>
823895
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/plugins/toolbar/prism-toolbar.min.js"></script>
824896
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/plugins/copy-to-clipboard/prism-copy-to-clipboard.min.js"></script>
825897
<script src="assets/js/mobile-nav.js"></script>
826-
<script src="https://peterbenoit.com/js/badge.js" data-mode="tracker"></script>
827-
<script src="https://uiguy.dev/libs/console.js"></script>
898+
<script src="https://www.peterbenoit.com/js/badge.js" data-mode="tracker"></script>
899+
<script src="https://www.uiguy.dev/libs/console.js"></script>
828900
</body>
829901
</html>

‎docs/index.html‎

Lines changed: 87 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,94 @@
33
<head>
44
<meta charset="UTF-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>RepoWidget - Professional GitHub Repository Display</title>
7-
<meta
8-
name="description"
9-
content="A lightweight, customizable widget to showcase GitHub repositories on any website."
10-
/>
11-
<link
12-
rel="stylesheet"
13-
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css"
14-
/>
6+
7+
<!-- Primary Meta Tags -->
8+
<title>RepoWidget - Professional GitHub Repository Display Widget</title>
9+
<meta name="title" content="RepoWidget - Professional GitHub Repository Display Widget" />
10+
<meta name="description" content="A lightweight, customizable JavaScript widget to showcase GitHub repositories on any website. Easy setup, responsive design, and fully customizable styling." />
11+
<meta name="keywords" content="github widget, repository display, javascript widget, portfolio showcase, github repos, open source, developer tools" />
12+
<meta name="author" content="Peter Benoit" />
13+
<meta name="robots" content="index, follow" />
14+
<meta name="language" content="English" />
15+
<meta name="revisit-after" content="7 days" />
16+
17+
<!-- Canonical URL -->
18+
<link rel="canonical" href="https://peterbenoit.github.io/RepoWidget/" />
19+
20+
<!-- Open Graph / Facebook -->
21+
<meta property="og:type" content="website" />
22+
<meta property="og:url" content="https://peterbenoit.github.io/RepoWidget/" />
23+
<meta property="og:title" content="RepoWidget - Professional GitHub Repository Display Widget" />
24+
<meta property="og:description" content="A lightweight, customizable JavaScript widget to showcase GitHub repositories on any website. Easy setup, responsive design, and fully customizable styling." />
25+
<meta property="og:image" content="https://peterbenoit.github.io/RepoWidget/assets/images/og-image.png" />
26+
<meta property="og:image:width" content="1200" />
27+
<meta property="og:image:height" content="630" />
28+
<meta property="og:site_name" content="RepoWidget" />
29+
<meta property="og:locale" content="en_US" />
30+
31+
<!-- Twitter -->
32+
<meta property="twitter:card" content="summary_large_image" />
33+
<meta property="twitter:url" content="https://peterbenoit.github.io/RepoWidget/" />
34+
<meta property="twitter:title" content="RepoWidget - Professional GitHub Repository Display Widget" />
35+
<meta property="twitter:description" content="A lightweight, customizable JavaScript widget to showcase GitHub repositories on any website. Easy setup, responsive design, and fully customizable styling." />
36+
<meta property="twitter:image" content="https://peterbenoit.github.io/RepoWidget/assets/images/og-image.png" />
37+
<meta property="twitter:creator" content="@peterbenoit" />
38+
39+
<!-- Favicons -->
40+
<link rel="icon" type="image/x-icon" href="assets/images/favicon.ico" />
41+
<link rel="icon" type="image/png" sizes="16x16" href="assets/images/favicon-16x16.png" />
42+
<link rel="icon" type="image/png" sizes="32x32" href="assets/images/favicon-32x32.png" />
43+
<link rel="apple-touch-icon" sizes="180x180" href="assets/images/apple-touch-icon.png" />
44+
<link rel="manifest" href="assets/manifest.json" />
45+
<meta name="theme-color" content="#0366d6" />
46+
<meta name="msapplication-TileColor" content="#0366d6" />
47+
<meta name="msapplication-config" content="assets/browserconfig.xml" />
48+
49+
<!-- DNS Prefetch -->
50+
<link rel="dns-prefetch" href="//cdnjs.cloudflare.com" />
51+
<link rel="dns-prefetch" href="//api.github.com" />
52+
<link rel="dns-prefetch" href="//cdn.jsdelivr.net" />
53+
54+
<!-- Preconnect -->
55+
<link rel="preconnect" href="https://cdnjs.cloudflare.com" crossorigin />
56+
<link rel="preconnect" href="https://fonts.googleapis.com" crossorigin />
57+
58+
<!-- CSS Resources -->
59+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.2.0/css/all.min.css" integrity="sha512-xh6O/CkQoPOWDdYTDqeRdPCVd1SpvCA9XXcUnZS2FmJNp1coAFzvtCN9BmamE+4aHK8yyUHUSCcJHgXloTyT2A==" crossorigin="anonymous" referrerpolicy="no-referrer" />
1560
<link rel="stylesheet" href="assets/css/styles.css" />
61+
1662
<!-- Syntax highlighting -->
17-
<link
18-
rel="stylesheet"
19-
href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/themes/prism.min.css"
20-
/>
21-
<link
22-
rel="stylesheet"
23-
href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/plugins/toolbar/prism-toolbar.min.css"
24-
/>
25-
<link rel="icon" href="assets/images/favicon.ico" type="image/x-icon" />
63+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/themes/prism.min.css" integrity="sha512-tN7Ec6zAFaVSG3TpNAKtk4DOHNpSwKHxxrsiw4GHKESGPs5njn/0sMCUMl2svV4wo4BK/rCP7juYz+zx+l6oeQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
64+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/plugins/toolbar/prism-toolbar.min.css" integrity="sha512-Dqf5X5AAp5789NYyWhUzDmjz6qmJ8k8pDGiQnlM6kAtjvzGlYgJ5vBSGTD2ZHJQNcaUFLI7EhDbN8XdJsKJKEQ==" crossorigin="anonymous" referrerpolicy="no-referrer" />
65+
66+
<!-- Structured Data -->
67+
<script type="application/ld+json">
68+
{
69+
"@context": "https://schema.org",
70+
"@type": "SoftwareApplication",
71+
"name": "RepoWidget",
72+
"description": "A lightweight, customizable JavaScript widget to showcase GitHub repositories on any website",
73+
"url": "https://peterbenoit.github.io/RepoWidget/",
74+
"author": {
75+
"@type": "Person",
76+
"name": "Peter Benoit",
77+
"url": "https://www.uiguy.dev"
78+
},
79+
"applicationCategory": "DeveloperApplication",
80+
"operatingSystem": "Any",
81+
"programmingLanguage": "JavaScript",
82+
"offers": {
83+
"@type": "Offer",
84+
"price": "0",
85+
"priceCurrency": "USD"
86+
},
87+
"license": "https://github.com/peterbenoit/RepoWidget/blob/main/LICENSE",
88+
"codeRepository": "https://github.com/peterbenoit/RepoWidget"
89+
}
90+
</script>
2691
</head>
2792
<body>
93+
<a href="https://www.uiguy.dev" rel="author" class="seo-author-link">Peter Benoit</a>
2894
<header class="header">
2995
<div class="container">
3096
<nav class="nav">
@@ -661,7 +727,7 @@ <h3>Resources</h3>
661727

662728
<div class="copyright">
663729
&copy; 2025 RepoWidget. Created by
664-
<a href="https://uiguy.dev">Peter Benoit</a>. Released under the MIT License.
730+
<a href="https://www.uiguy.dev">Peter Benoit</a>. Released under the MIT License.
665731
</div>
666732
</div>
667733
</footer>
@@ -673,7 +739,7 @@ <h3>Resources</h3>
673739
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.25.0/plugins/copy-to-clipboard/prism-copy-to-clipboard.min.js"></script>
674740
<script src="assets/js/docs.js"></script>
675741
<script src="assets/js/mobile-nav.js"></script>
676-
<script src="https://peterbenoit.com/js/badge.js" data-mode="tracker"></script>
677-
<script src="https://uiguy.dev/libs/console.js"></script>
742+
<script src="https://www.peterbenoit.com/js/badge.js" data-mode="tracker"></script>
743+
<script src="https://www.uiguy.dev/libs/console.js"></script>
678744
</body>
679745
</html>

0 commit comments

Comments
 (0)