Skip to content

Commit 8371b13

Browse files
committed
docs: improve documentation site
- Enhance documentation with meta tags, structured data, and better styling - Consolidate CSS organization and remove commented code
1 parent f5d7694 commit 8371b13

7 files changed

Lines changed: 351 additions & 116 deletions

File tree

docs/docusaurus.config.ts

Lines changed: 173 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
2+
13
import { themes as prismThemes } from 'prism-react-renderer';
24
import type { Config } from '@docusaurus/types';
35
import type * as Preset from '@docusaurus/preset-classic';
46

5-
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
6-
77
const config: Config = {
88
title: 'Catbee Utils',
99
tagline: 'Utility Modules for Node.js',
@@ -16,6 +16,157 @@ const config: Config = {
1616
url: 'https://catbee-utils.npm.hprasath.com',
1717
baseUrl: '/',
1818

19+
headTags: [
20+
{
21+
tagName: 'meta',
22+
attributes: {
23+
name: 'description',
24+
content: 'Catbee Utils - A collection of reusable utility modules for Node.js and TypeScript projects.',
25+
},
26+
},
27+
{
28+
tagName: 'meta',
29+
attributes: {
30+
name: 'keywords',
31+
content: 'catbee, utils, node.js, typescript, javascript, utilities, library, npm, express',
32+
},
33+
},
34+
{
35+
tagName: 'meta',
36+
attributes: {
37+
property: 'og:title',
38+
content: 'Catbee Utils - Utility Modules for Node.js',
39+
},
40+
},
41+
{
42+
tagName: 'meta',
43+
attributes: {
44+
property: 'og:description',
45+
content: 'A powerful and modular collection of utilities for Node.js and TypeScript projects.',
46+
},
47+
},
48+
{
49+
tagName: 'meta',
50+
attributes: {
51+
property: 'og:type',
52+
content: 'website',
53+
},
54+
},
55+
{
56+
tagName: 'meta',
57+
attributes: {
58+
property: 'og:url',
59+
content: 'https://catbee-utils.npm.hprasath.com',
60+
},
61+
},
62+
{
63+
tagName: 'meta',
64+
attributes: {
65+
property: 'og:image',
66+
content: 'https://catbee-utils.npm.hprasath.com/favicon/android-chrome-512x512.png',
67+
},
68+
},
69+
{
70+
tagName: 'meta',
71+
attributes: {
72+
name: 'twitter:card',
73+
content: 'summary_large_image',
74+
},
75+
},
76+
{
77+
tagName: 'meta',
78+
attributes: {
79+
name: 'twitter:title',
80+
content: 'Catbee Utils - Utility Modules for Node.js',
81+
},
82+
},
83+
{
84+
tagName: 'meta',
85+
attributes: {
86+
name: 'twitter:description',
87+
content: 'Reusable utility modules for Node.js and TypeScript, designed for performance and simplicity.',
88+
},
89+
},
90+
{
91+
tagName: 'meta',
92+
attributes: {
93+
name: 'twitter:image',
94+
content: 'https://catbee-utils.npm.hprasath.com/favicon/android-chrome-512x512.png',
95+
},
96+
},
97+
{
98+
tagName: 'meta',
99+
attributes: {
100+
name: 'viewport',
101+
content: 'width=device-width, initial-scale=1',
102+
},
103+
},
104+
{
105+
tagName: 'link',
106+
attributes: {
107+
rel: 'icon',
108+
href: '/favicon/favicon.ico',
109+
},
110+
},
111+
{
112+
tagName: 'meta',
113+
attributes: {
114+
name: 'theme-color',
115+
content: '#000'
116+
},
117+
},
118+
{
119+
tagName: 'link',
120+
attributes: {
121+
rel: 'manifest',
122+
href: '/site.webmanifest',
123+
},
124+
},
125+
{
126+
tagName: 'link',
127+
attributes: {
128+
rel: 'apple-touch-icon',
129+
sizes: '180x180',
130+
href: '/favicon/apple-touch-icon.png',
131+
},
132+
},
133+
{
134+
tagName: 'meta',
135+
attributes: {
136+
name: 'robots',
137+
content: 'index, follow',
138+
},
139+
},
140+
{
141+
tagName: 'meta',
142+
attributes: {
143+
name: 'algolia-site-verification',
144+
content: 'C6E636047538A2FF'
145+
}
146+
},
147+
{
148+
tagName: 'script',
149+
attributes: {
150+
type: 'application/ld+json',
151+
},
152+
innerHTML: JSON.stringify({
153+
'@context': 'https://schema.org',
154+
'@type': 'SoftwareSourceCode',
155+
name: 'Catbee Utils',
156+
description:
157+
'Catbee Utils - A collection of reusable utility modules for Node.js and TypeScript projects.',
158+
url: 'https://catbee-utils.npm.hprasath.com',
159+
codeRepository: 'https://github.com/catbee-technologies/catbee-utils',
160+
license: 'https://opensource.org/licenses/MIT',
161+
programmingLanguage: 'TypeScript',
162+
author: {
163+
'@type': 'Organization',
164+
name: 'Catbee Technologies',
165+
},
166+
}),
167+
}
168+
],
169+
19170
organizationName: 'catbee-technologies',
20171
projectName: '@catbee/utils',
21172

@@ -46,13 +197,25 @@ const config: Config = {
46197
onUntruncatedBlogPosts: 'warn',
47198
},
48199
theme: {
49-
customCss: './src/css/custom.css',
200+
customCss: ['./src/css/styles.css']
50201
},
51202
} satisfies Preset.Options,
52203
],
53204
],
54205

55206
themeConfig: {
207+
colorMode: {
208+
defaultMode: 'dark',
209+
disableSwitch: false,
210+
respectPrefersColorScheme: true,
211+
},
212+
announcementBar: {
213+
id: 'new-release',
214+
content: '🚀 Catbee Utils v0.0.7 is now available on <a href="https://www.npmjs.com/package/@catbee/utils">npm</a>!',
215+
backgroundColor: '#6a4fbc',
216+
textColor: '#ffffff',
217+
isCloseable: true,
218+
},
56219
navbar: {
57220
title: 'Catbee Utils',
58221
logo: {
@@ -69,6 +232,7 @@ const config: Config = {
69232
{ to: '/license', label: 'License', position: 'left' },
70233
// { to: '/contributors', label: 'Contributors', position: 'left' },
71234
{ href: 'https://github.com/catbee-technologies/catbee-utils', label: 'GitHub', position: 'right' },
235+
{ href: 'https://www.npmjs.com/package/@catbee/utils', label: 'NPM', position: 'right' }
72236
]
73237
},
74238
footer: {
@@ -80,7 +244,12 @@ const config: Config = {
80244
// width: 32,
81245
// height: 32,
82246
// },
83-
copyright: `Copyright © ${new Date().getFullYear()} Catbee Technologies. All Rights Reserved.`,
247+
copyright: `Copyright © ${new Date().getFullYear()} Catbee Technologies.`,
248+
},
249+
algolia: {
250+
appId: '9XAZEAMSRU',
251+
apiKey: 'db1d1b7281ef681eec43858e19fbe7a9',
252+
indexName: 'Catbee Utils'
84253
},
85254
prism: {
86255
theme: prismThemes.github,

docs/src/css/custom.css

Lines changed: 0 additions & 77 deletions
This file was deleted.

0 commit comments

Comments
 (0)