From c3ea3a6f4a11d366282a9c77fff90475bc02168c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Teles?= Date: Fri, 12 Jul 2024 14:12:03 -0300 Subject: [PATCH] fix: add meta description to documentation pages --- src/components/Header.astro | 2 +- src/layouts/Docs.astro | 6 +++--- src/pages/docs/{api.md => api.mdx} | 1 + src/pages/docs/{filters.md => filters.mdx} | 1 + .../{getting-credentials.md => getting-credentials.mdx} | 1 + src/pages/docs/{index.md => index.mdx} | 1 + src/pages/docs/{note.md => note.mdx} | 1 + src/pages/docs/usage.mdx | 3 ++- 8 files changed, 11 insertions(+), 5 deletions(-) rename src/pages/docs/{api.md => api.mdx} (98%) rename src/pages/docs/{filters.md => filters.mdx} (96%) rename src/pages/docs/{getting-credentials.md => getting-credentials.mdx} (95%) rename src/pages/docs/{index.md => index.mdx} (88%) rename src/pages/docs/{note.md => note.mdx} (81%) diff --git a/src/components/Header.astro b/src/components/Header.astro index c03ec24..e9bbe69 100644 --- a/src/components/Header.astro +++ b/src/components/Header.astro @@ -17,7 +17,7 @@ import Logo from "../assets/holysheets-logo.svg"; alt="HolySheets Logo" class="w-8 h-8 mr-2 relative top-[-2px]" /> - HolySheets + HolySheets! { type Props = MarkdownLayoutProps<{ title: string; - previous?: string; - next?: string; slug: string; + description: string; }>; -const { title, slug } = Astro.props.frontmatter; +const { title, slug, description } = Astro.props.frontmatter; const currentMenuIndex = sidebarItems.findIndex((item) => item.slug === slug); const { prev, next } = { prev: currentMenuIndex === 0 ? null : sidebarItems[currentMenuIndex - 1], @@ -198,6 +197,7 @@ const { prev, next } = { + {title ? title + " - Holysheets!" : ""} diff --git a/src/pages/docs/api.md b/src/pages/docs/api.mdx similarity index 98% rename from src/pages/docs/api.md rename to src/pages/docs/api.mdx index c6912dd..e4f7d93 100644 --- a/src/pages/docs/api.md +++ b/src/pages/docs/api.mdx @@ -3,6 +3,7 @@ layout: ../../layouts/Docs.astro title: API slug: api icon: code +description: Learn how to use the HolySheets API to interact with your Google Sheets data. --- # API documentation diff --git a/src/pages/docs/filters.md b/src/pages/docs/filters.mdx similarity index 96% rename from src/pages/docs/filters.md rename to src/pages/docs/filters.mdx index f38e2d0..af27299 100644 --- a/src/pages/docs/filters.md +++ b/src/pages/docs/filters.mdx @@ -3,6 +3,7 @@ layout: ../../layouts/Docs.astro title: Filter conditions slug: filters icon: filter +description: Learn how to use filter conditions to query data from your Google Sheets using HolySheets. --- # Filter conditions diff --git a/src/pages/docs/getting-credentials.md b/src/pages/docs/getting-credentials.mdx similarity index 95% rename from src/pages/docs/getting-credentials.md rename to src/pages/docs/getting-credentials.mdx index dcb278b..40e1449 100644 --- a/src/pages/docs/getting-credentials.md +++ b/src/pages/docs/getting-credentials.mdx @@ -3,6 +3,7 @@ layout: ../../layouts/Docs.astro title: Getting Credentials slug: getting-credentials icon: contract +description: Learn how to get Google credentials for your project to use with HolySheets. --- # Getting Google Credentials diff --git a/src/pages/docs/index.md b/src/pages/docs/index.mdx similarity index 88% rename from src/pages/docs/index.md rename to src/pages/docs/index.mdx index 26bf133..2812144 100644 --- a/src/pages/docs/index.md +++ b/src/pages/docs/index.mdx @@ -3,6 +3,7 @@ layout: ../../layouts/Docs.astro title: Introduction slug: introduction icon: book +description: Learn about HolySheets! and how it simplifies the process of interacting with the Google Sheets API. --- # Introduction diff --git a/src/pages/docs/note.md b/src/pages/docs/note.mdx similarity index 81% rename from src/pages/docs/note.md rename to src/pages/docs/note.mdx index 09362b8..26859f2 100644 --- a/src/pages/docs/note.md +++ b/src/pages/docs/note.mdx @@ -3,6 +3,7 @@ layout: ../../layouts/Docs.astro title: Note slug: note icon: note +description: Learn about the limitations of HolySheets! and when to use it. --- # Note diff --git a/src/pages/docs/usage.mdx b/src/pages/docs/usage.mdx index 0d4cb83..abe2c43 100644 --- a/src/pages/docs/usage.mdx +++ b/src/pages/docs/usage.mdx @@ -3,6 +3,7 @@ layout: ../../layouts/Docs.astro title: Usage slug: usage icon: play +description: Learn how to use HolySheets in your TypeScript project. --- import Alert from '../../components/Alert.astro' @@ -18,7 +19,7 @@ interface User { age: number; } -const hollySheets = new HolySheets({ +const holySheets = new HolySheets({ spreadsheetId: "spreadsheet-id", privateKey: credentials.private_key, // Your credentials clientEmail: credentials.client_email, // Your client email