Skip to content

Commit 801bc23

Browse files
committed
feat: add favicon and update configuration for improved site integration
1 parent 5ceb467 commit 801bc23

3 files changed

Lines changed: 103 additions & 53 deletions

File tree

docs/astro.config.mjs

Lines changed: 57 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -3,57 +3,61 @@ import { defineConfig } from 'astro/config';
33
import starlight from '@astrojs/starlight';
44

55
export default defineConfig({
6-
site: 'https://www.repowidget.com',
7-
integrations: [
8-
starlight({
9-
title: 'RepoWidget',
10-
description: 'A lightweight, customizable JavaScript widget to showcase GitHub repositories on any website.',
11-
social: [
12-
{ icon: 'github', label: 'GitHub', href: 'https://github.com/peterbenoit/RepoWidget' },
13-
{ icon: 'npm', label: 'npm', href: 'https://www.npmjs.com/package/repo-widget' },
14-
],
15-
head: [
16-
{ tag: 'meta', attrs: { name: 'author', content: 'Peter Benoit' } },
17-
{ tag: 'meta', attrs: { property: 'og:type', content: 'website' } },
18-
{ tag: 'meta', attrs: { property: 'og:site_name', content: 'RepoWidget' } },
19-
{ tag: 'meta', attrs: { name: 'twitter:card', content: 'summary' } },
20-
{ tag: 'meta', attrs: { name: 'twitter:creator', content: '@peterbenoit' } },
21-
{ tag: 'meta', attrs: { name: 'color-scheme', content: 'light dark' } },
22-
],
23-
editLink: {
24-
baseUrl: 'https://github.com/peterbenoit/RepoWidget/edit/main/docs/',
25-
},
26-
sidebar: [
27-
{
28-
label: 'Getting Started',
29-
items: [
30-
{ label: 'Introduction', slug: 'getting-started/introduction' },
31-
{ label: 'Installation', slug: 'getting-started/installation' },
32-
{ label: 'Quick Start', slug: 'getting-started/quick-start' },
33-
],
34-
},
35-
{
36-
label: 'API Reference',
37-
items: [
38-
{ label: 'Configuration Options', slug: 'api/configuration' },
39-
{ label: 'Full API Reference', slug: 'api/reference' },
40-
],
41-
},
42-
{
43-
label: 'Examples',
44-
items: [
45-
{ label: 'Code Examples', slug: 'examples/code-examples' },
46-
{ label: 'Live Demo', slug: 'examples/demo' },
47-
],
48-
},
49-
{
50-
label: 'Project',
51-
items: [
52-
{ label: 'Changelog', slug: 'project/changelog' },
53-
{ label: 'Contributing', slug: 'project/contributing' },
54-
],
55-
},
56-
],
57-
}),
58-
],
6+
site: 'https://www.repowidget.com',
7+
integrations: [
8+
starlight({
9+
title: 'RepoWidget',
10+
description: 'A lightweight, customizable JavaScript widget to showcase GitHub repositories on any website.',
11+
favicon: '/favicon.svg',
12+
social: [
13+
{ icon: 'github', label: 'GitHub', href: 'https://github.com/peterbenoit/RepoWidget' },
14+
{ icon: 'npm', label: 'npm', href: 'https://www.npmjs.com/package/repo-widget' },
15+
],
16+
head: [
17+
{ tag: 'link', attrs: { rel: 'icon', type: 'image/svg+xml', href: '/favicon.svg' } },
18+
{ tag: 'link', attrs: { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/favicon-32x32.png' } },
19+
{ tag: 'link', attrs: { rel: 'apple-touch-icon', sizes: '180x180', href: '/apple-touch-icon.png' } },
20+
{ tag: 'meta', attrs: { name: 'author', content: 'Peter Benoit' } },
21+
{ tag: 'meta', attrs: { property: 'og:type', content: 'website' } },
22+
{ tag: 'meta', attrs: { property: 'og:site_name', content: 'RepoWidget' } },
23+
{ tag: 'meta', attrs: { name: 'twitter:card', content: 'summary' } },
24+
{ tag: 'meta', attrs: { name: 'twitter:creator', content: '@peterbenoit' } },
25+
{ tag: 'meta', attrs: { name: 'color-scheme', content: 'light dark' } },
26+
],
27+
editLink: {
28+
baseUrl: 'https://github.com/peterbenoit/RepoWidget/edit/main/docs/',
29+
},
30+
sidebar: [
31+
{
32+
label: 'Getting Started',
33+
items: [
34+
{ label: 'Introduction', slug: 'getting-started/introduction' },
35+
{ label: 'Installation', slug: 'getting-started/installation' },
36+
{ label: 'Quick Start', slug: 'getting-started/quick-start' },
37+
],
38+
},
39+
{
40+
label: 'API Reference',
41+
items: [
42+
{ label: 'Configuration Options', slug: 'api/configuration' },
43+
{ label: 'Full API Reference', slug: 'api/reference' },
44+
],
45+
},
46+
{
47+
label: 'Examples',
48+
items: [
49+
{ label: 'Code Examples', slug: 'examples/code-examples' },
50+
{ label: 'Live Demo', slug: 'examples/demo' },
51+
],
52+
},
53+
{
54+
label: 'Project',
55+
items: [
56+
{ label: 'Changelog', slug: 'project/changelog' },
57+
{ label: 'Contributing', slug: 'project/contributing' },
58+
],
59+
},
60+
],
61+
}),
62+
],
5963
});

docs/public/favicon.svg

Lines changed: 23 additions & 0 deletions
Loading

docs/src/assets/images/favicon.svg

Lines changed: 23 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)