Skip to content

Commit b53db5f

Browse files
committed
refactor(readme): updated readme.md
1 parent 8beb836 commit b53db5f

File tree

1 file changed

+37
-20
lines changed

1 file changed

+37
-20
lines changed

README.md

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,6 @@ While this approach offers flexibility and control, it comes with some limitatio
7474

7575
# Shadcn + Astro — Ink Landing Page
7676

77-
A modern, responsive business landing page built with [Astro](https://astro.build/) and [ShadcnUI](https://ui.shadcn.com/).
78-
7977
This project showcases a complete business website with sections for Header, Hero, Changelog Timeline,FAQ, and call-to-action components.
8078

8179
## ✨ Features
@@ -119,7 +117,6 @@ shadcn-studio-astro-template/
119117
│ ├── pages/ # Route-based pages
120118
│ │ ├── 404.astro # 404 page
121119
│ │ ├── index.astro # Home page
122-
│ │ ├── login.astro # Login page
123120
│ │ └── rss.xml.js # RSS feed generator
124121
│ │
125122
│ ├── styles/
@@ -230,27 +227,47 @@ export const siteConfig = {
230227
}
231228
```
232229

233-
## 📦 Dependencies
230+
### 🔍 SEO & Site Configuration
231+
232+
Configure the site's SEO and global metadata in `src/consts.ts`. These settings power the `HeadSeo.astro` layout and `seo.ts` helpers so pages have correct titles, descriptions, and social previews.
233+
234+
Recommended fields:
235+
236+
- `siteTitle`: The site-wide default title.
237+
- `siteDescription`: Default meta description for pages.
238+
- `siteUrl`: The canonical base URL for building absolute links.
239+
- `siteLocale`: Locale string used for html/lang and Open Graph (e.g. `en-US`).
240+
- `siteAuthor`: Default author/creator name.
241+
- `siteKeywords`: Array of SEO keywords.
242+
- `socialImage`: Path to the default social preview image (OG/Twitter card).
243+
- `faviconPath`: Path to the favicon in `/public`.
244+
- `themeColor`: Theme color meta for browsers and PWA.
245+
- `twitterHandle`: Official Twitter/X handle for site cards.
246+
- `analyticsId`: Optional analytics measurement id (Google Analytics, Plausible, etc.).
234247

235-
### Main Dependencies
248+
Example `siteConfig` with SEO fields:
236249

237-
- **Astro 5.16.6** - Fast static site generator with zero JS by default
238-
- **React 19.2.3** - UI library for interactive components
239-
- **Tailwind CSS 4.1.18** - Utility-first CSS framework
240-
- **Radix UI** - Unstyled, accessible component primitives
241-
- **Class Variance Authority** - Type-safe component variant management
242-
- **@Astrojs/React** - Astro integration for React components
243-
- **@Astrojs/MDX** - MDX support for Astro
244-
- **@Astrojs/Sitemap** - Automatic sitemap generation
245-
- **@Astrojs/RSS** - RSS feed generation
250+
```typescript
251+
// Example SEO & site settings — edit src/consts.ts
252+
export const siteConfig = {
253+
siteTitle: 'Ink — Blog Landing Page',
254+
siteDescription: 'A beautifully crafted Blog and product landing page built with Astro and shadcn/studio.',
255+
siteUrl: 'https://example.com',
256+
siteLocale: 'en-US',
257+
siteAuthor: 'Shadcn Studio',
258+
siteKeywords: ['Blog', 'landing page', 'astro', 'shadcn'],
259+
socialImage: '/images/social-preview.png',
260+
faviconPath: '/favicon/favicon.ico',
261+
themeColor: '#0ea5e9',
262+
twitterHandle: '@ShadcnStudio',
263+
analyticsId: '' // optional
264+
}
265+
```
246266

247-
### Key Plugins
267+
Tips:
248268

249-
- **lucide-react** - Beautiful, consistent icon library with 562+ React icons
250-
- **prettier-plugin-tailwindcss** - Automatic Tailwind CSS class sorting
251-
- **@tailwindcss/typography** - Professional typographic styles
252-
- **prettier-plugin-astro** - Astro code formatting support
253-
- **ESLint & TypeScript** - Code quality and type safety tools
269+
- Keep `siteUrl` consistent with your deployed domain to ensure correct canonical and Open Graph URLs.
270+
- Place social preview images in `public/images` and reference them with absolute paths (e.g. `/images/social-preview.png`).
254271

255272
## 🌐 Deployment
256273

0 commit comments

Comments
 (0)