From ba3efc9ec79804d4a711f7090aba677c2d2f786e Mon Sep 17 00:00:00 2001 From: Luccas Mateus de Medeiros Gomes Date: Thu, 18 May 2023 11:51:01 -0300 Subject: [PATCH] [docs][xs] - remove my version of files --- site/content/howto/analytics.md | 22 -------- site/content/howto/page-metadata.md | 54 ------------------- site/content/howto/sitemaps.md | 82 ----------------------------- 3 files changed, 158 deletions(-) delete mode 100644 site/content/howto/analytics.md delete mode 100644 site/content/howto/page-metadata.md delete mode 100644 site/content/howto/sitemaps.md diff --git a/site/content/howto/analytics.md b/site/content/howto/analytics.md deleted file mode 100644 index 7b9df29b..00000000 --- a/site/content/howto/analytics.md +++ /dev/null @@ -1,22 +0,0 @@ -# How to add web analytics? - -- Install the following packages -``` -npm install @flowershow/core -``` -- Add the following to `/pages/_app.tsx` -``` -import { pageview } from "@flowershow/core"; -``` -- Add this to the `MyApp` function inside of `_app.tsx` -``` - useEffect(() => { - const handleRouteChange = (url) => { - pageview(url, {YOUR GA_ID}); - }; - router.events.on("routeChangeComplete", handleRouteChange); - return () => { - router.events.off("routeChangeComplete", handleRouteChange); - }; - }, [router.events]); -``` diff --git a/site/content/howto/page-metadata.md b/site/content/howto/page-metadata.md deleted file mode 100644 index 71505953..00000000 --- a/site/content/howto/page-metadata.md +++ /dev/null @@ -1,54 +0,0 @@ -# How to customize the page metadata e.g title, favicon? - -- Install the following packages - -``` -npm install next-seo -``` - -- Add the following tag to the `MyApp` component in `/pages/_app.tsx` - -``` - -``` - -- You can check all the possible options at the [project readme](https://github.com/garmeeh/next-seo#nextseo-options) - -Below is an example of a typical configuration - -``` - -``` diff --git a/site/content/howto/sitemaps.md b/site/content/howto/sitemaps.md deleted file mode 100644 index c01a0a51..00000000 --- a/site/content/howto/sitemaps.md +++ /dev/null @@ -1,82 +0,0 @@ -# How to build a sitemap? - -- install the following packages - -``` -npm install globby prettier @flowershow/markdowndb -``` - -- Add the following script to a `/scripts/sitemap.mjs` file in your project - -``` -import { writeFileSync } from "fs"; -import { globby } from "globby"; -import prettier from "prettier"; -import { MarkdownDB } from "@flowershow/markdowndb"; - -const dbPath = "markdown.db"; -const client = new MarkdownDB({ - client: "sqlite3", - connection: { - filename: dbPath, - }, -}); - -const clientPromise = client.init(); - -export default async function sitemap() { - const prettierConfig = await prettier.resolveConfig(""); - const mddb = await clientPromise; - const allFiles = await mddb.getFiles({ extensions: ["mdx", "md"] }); - const contentPages = allFiles - .filter((x) => !x.metadata?.isDraft) - .map((x) => `/${x.url_path}`); - const pages = await globby([ - "pages/*.(js|tsx)", - "!pages/_*.(js|tsx)", - "!pages/api", - "!pages/404.(js|tsx)", - "!pages/**/\\[\\[*\\]\\].(js|tsx)", // pages/[[...slug]].tsx - ]); - - const siteUrl = {YOUR WEBSITE DOMAIN} - - const sitemap = ` - - - ${pages - .concat(contentPages) - .map((page) => { - const path = page - .replace("pages/", "/") - .replace("public/", "/") - .replace(/\.js|.tsx|.mdx|.md[^\/.]+$/, "") - .replace("/feed.xml", ""); - const route = path === "/index" ? "" : path; - return ` - - ${siteUrl}${route} - - `; - }) - .join("")} - - `; - - const formatted = prettier.format(sitemap, { - ...prettierConfig, - parser: "html", - }); - - if (siteUrl) { - writeFileSync("public/sitemap.xml", formatted); - console.log("Sitemap generated..."); - } -} -``` - -- add this to the scripts section in your package.json filename - -``` -"prebuild": "./scripts/sitemap.mjs", -```