feat: implement site's base open graph data (#50)

babblebey · web-flow · commit 904bb117c60c · 2024-04-20T13:04:52.000+01:00
This pull request implements the default web app's open-graph data, configuring all `meta` tags for open-graph consumptions on all site. ### Changes Made - Modified `base.astro` layout to accept new props with some default value set... see below... - `ogImageUrl` - an open-graph image url slated to be configured per page depending on its content but set to use a default image as value incases where it is not provided at integration of the `base.astro` layout - `description` - an excerpt of a page's content with a default of drawn from the `SITE_META_DESCRIPTION` which is used as value when value isn't provided at integration - `subtitle` - used as second descriptive text in site's title with default value - Added a static `og.png` image to `public` directory used as default value for `ogImageUrl` prop - Implemented all required `meta` tags for open-graph and twitter cards specific ones - Added 2 new constants - `SITE_META_DESCRIPTION` - a string used as default value for the `description` prop on the `base.astro` layout. - `SITE_META_KEYWORDS` - an list of keywords integrated on the `meta:keywords` tag - Modified site's favicon to temporarily use a book icon svg, replacing the default `astrojs` logo ### Screencast [screencast-vercel.com-2024.04.20-12_35_42.webm](https://github.com/babblebey/jargons.dev/assets/25631971/2cf5f6a0-412b-4171-a370-b6ec363fc300) 📖
diff --git a/constants.js b/constants.js
@@ -1,4 +1,23 @@
 export const PROJECT_REPO_DETAILS = {
   repoFullname: import.meta.env.PUBLIC_PROJECT_REPO,
   repoMainBranchRef: import.meta.env.PUBLIC_PROJECT_REPO_BRANCH_REF
-}
+}
+
+export const SITE_META_DESCRIPTION = "A community-driven dictionary that simplifies software, engineering and tech terms for all levels. Curated by contributors, jargons.dev offers clear, easy-to-understand definitions."
+
+export const SITE_META_KEYWORDS = [  
+  "dev jargon",  
+  "dev jargons",  
+  "software engineering terms",  
+  "web dev terms",  
+  "software jargons",  
+  "software terms",  
+  "developer jargons",  
+  "web jargons",  
+  "web development terms",  
+  "software development jargons",
+  "software engineering dictionary",
+  "dev dictionary",
+  "developer dictionary",
+  "software development dictionary",
+];
diff --git a/public/favicon.svg b/public/favicon.svg
@@ -1,9 +1,9 @@
-<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 128 128">
-    <path d="M50.4 78.5a75.1 75.1 0 0 0-28.5 6.9l24.2-65.7c.7-2 1.9-3.2 3.4-3.2h29c1.5 0 2.7 1.2 3.4 3.2l24.2 65.7s-11.6-7-28.5-7L67 45.5c-.4-1.7-1.6-2.8-2.9-2.8-1.3 0-2.5 1.1-2.9 2.7L50.4 78.5Zm-1.1 28.2Zm-4.2-20.2c-2 6.6-.6 15.8 4.2 20.2a17.5 17.5 0 0 1 .2-.7 5.5 5.5 0 0 1 5.7-4.5c2.8.1 4.3 1.5 4.7 4.7.2 1.1.2 2.3.2 3.5v.4c0 2.7.7 5.2 2.2 7.4a13 13 0 0 0 5.7 4.9v-.3l-.2-.3c-1.8-5.6-.5-9.5 4.4-12.8l1.5-1a73 73 0 0 0 3.2-2.2 16 16 0 0 0 6.8-11.4c.3-2 .1-4-.6-6l-.8.6-1.6 1a37 37 0 0 1-22.4 2.7c-5-.7-9.7-2-13.2-6.2Z" />
+<svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" width="124" height="124" viewBox="0 0 24 24">
+    <path fill-rule="evenodd" d="M6 2a2 2 0 0 0-2 2v15a3 3 0 0 0 3 3h12a1 1 0 1 0 0-2h-2v-2h2a1 1 0 0 0 1-1V4a2 2 0 0 0-2-2h-8v16h5v2H7a1 1 0 1 1 0-2h1V2H6Z" clip-rule="evenodd"/>
     <style>
         path { fill: #000; }
         @media (prefers-color-scheme: dark) {
             path { fill: #FFF; }
         }
     </style>
-</svg>
+</svg>
diff --git a/public/og.png b/public/og.png
diff --git a/src/layouts/base.astro b/src/layouts/base.astro
@@ -2,8 +2,16 @@
 import "@fontsource/inter";
 import "@fontsource/ibm-plex-mono";
 import "../base.css";
+import { SITE_META_KEYWORDS, SITE_META_DESCRIPTION } from "../../constants.js";
 
-const { pageTitle, class:list } = Astro.props;
+const { props, url } = Astro;
+const { 
+	pageTitle, 
+	class:list, 
+	ogImageUrl = `${url.origin}/og.png`, 
+	description = SITE_META_DESCRIPTION,
+	subtitle = "Developer Jargons" 
+} = props;
 ---
 
 <html lang="en">
@@ -12,7 +20,23 @@ const { pageTitle, class:list } = Astro.props;
 		<link rel="icon" type="image/svg+xml" href="/favicon.svg" />
 		<meta name="viewport" content="width=device-width" />
 		<meta name="generator" content={Astro.generator} />
-		<title>{ pageTitle } - Developer Jargons</title>
+		<meta name="description" content={description} />
+		<meta name="keyword" content={SITE_META_KEYWORDS.join(",")} />
+
+		<meta property="og:url" content={url.href}>
+		<meta property="og:type" content="website">
+		<meta property="og:title" content={`${ pageTitle } - ${subtitle}`}>
+		<meta property="og:description" content={description}>
+		<meta property="og:image" content={ogImageUrl}>
+
+		<meta name="twitter:card" content="summary_large_image">
+		<meta property="twitter:domain" content={url.host}>
+		<meta property="twitter:url" content={url.href}>
+		<meta name="twitter:title" content={`${ pageTitle } - ${subtitle}`}>
+		<meta name="twitter:description" content={description}>
+		<meta name="twitter:image" content={ogImageUrl}>
+
+		<title>{ pageTitle } - {subtitle}</title>
 	</head>
 	<body class={list}>
     <slot />
