prepare example readmes

ahuseyn · ahuseyn · commit d4039a8c8a61 · 2025-11-21T10:46:53.000+01:00
diff --git a/docs/explanation/index.md b/docs/explanation/index.md
@@ -5,7 +5,7 @@ description: "High-level conceptual guides that provide background information a
 
 I see you found the root of the Explanatory guides! Explanatory guides are a place where we step away from code and talk high-level concepts and import background information. If you are looking to grow your understanding of Headless WordPress with the toolkit, you are in the right place.
 
-> [!note] Learn More
+> [!NOTE] Learn More
 > For more info on how we layout our documentation and the the role played by Explanatory Guides, please read about the [_Diátaxis_](https://diataxis.fr/explanation/) approach we use.
 
 ## Contributing
diff --git a/docs/how-to/index.md b/docs/how-to/index.md
@@ -5,7 +5,7 @@ description: "Step-by-step guides for implementing specific features and achievi
 
 I see you found the root of the How-to guides! How-to guides are a place where we walk you through implementing specific features of the Headless WordPress Toolkit. If you are looking to achieve a specific goal with the toolkit, you are in the right place.
 
-> [!note] Learn More
+> [!NOTE] Learn More
 > For more info on how we layout our documentation and the the role played by How-to guides, please read about the [_Diátaxis_](https://diataxis.fr/how-to-guides/) approach we use.
 
 ## Contributing
diff --git a/examples/angular/template-hierarchy-data-fetching/README.md b/examples/angular/template-hierarchy-data-fetching/README.md
@@ -7,7 +7,7 @@ description: "In this example we show how to implement the **WordPress Template
 
 In this example we show how to implement the **WordPress Template Hierarchy in Angular** for use with a Headless WordPress backend using WPGraphQL.
 
-## Getting Started 🚀
+## Getting Started
 
 > [!IMPORTANT]
 > **Docker Desktop** needs to be installed to run WordPress locally.
@@ -24,7 +24,7 @@ In this example we show how to implement the **WordPress Template Hierarchy in A
 > [!NOTE]
 > When you kill the long running process this will not shutdown the local WP instance, only Angular. You must run `npm run example:stop` to kill the local WP server.
 
-## Trouble Shooting 🛠️
+## Trouble Shooting
 
 1. I get "Page Not Found. Sorry, the page you are looking for does not exist. Please check the URL." when opening the Angular app and trying to navigate through it.
 - Run `npm run backend:start` and verify that **http://localhost:3000/api/templates** returns correct data.
diff --git a/examples/astro/previews/README.md b/examples/astro/previews/README.md
@@ -3,7 +3,7 @@ title: "Astro Headless WordPress Previews Example"
 description: "In this example, we show how to implement **Headless WordPress Previews in Astro** using the **`hwp-previews`** plugin and WPGraphQL. This setup allows content creators to preview draft posts directly in the Astro frontend from the WordPress admin panel. We use **URQL** for all routing and fetching page content."
 ---
 
-# Astro Headless WordPress Previews Example 🚀
+# Astro Headless WordPress Previews Example
 
 In this example, we show how to implement **Headless WordPress Previews in Astro** using the **`hwp-previews`** plugin and WPGraphQL. This setup allows content creators to preview draft posts directly in the Astro frontend from the WordPress admin panel. We use **URQL** for all routing and fetching page content.
 
@@ -25,6 +25,6 @@ In this example, we show how to implement **Headless WordPress Previews in Astro
 3.  Edit any draft post.
 4.  In the editor, click the **"Preview"** button. The post should open in the Astro frontend, displaying the draft content.
 
-## Trouble Shooting 🛠️
+## Trouble Shooting
 
 To reset the WP server and re-run setup you can run `npm run example:prune` and confirm "Yes" at any prompts.
diff --git a/examples/next/apollo-client-data-fetch/README.md b/examples/next/apollo-client-data-fetch/README.md
@@ -1,5 +1,5 @@
 ---
-title: "Example: Fetching data from WordPress with Apollo Client in Next.js"
+title: "Fetching data from WordPress with Apollo Client in Next.js"
 description: "This example demonstrates various approaches to integrate WordPress as a headless CMS with a Next.js frontend using Apollo Client. It showcases different data fetching strategies, state management techniques, and modern web development patterns in a real-world application context."
 ---
 
diff --git a/examples/next/client-app-router-fetch-data/README.md b/examples/next/client-app-router-fetch-data/README.md
@@ -1,27 +1,10 @@
 ---
-title: "Example: Next.js App Router using the Fetch API"
+title: "Next.js App Router using the Fetch API"
 description: "An example headless WordPress application using Next.js App Router and the fetch API to fetch data from WordPress using WPGraphQL It showcases different data fetching strategies, state management techniques, and modern web development patterns in a real-world application context. This also contains a full example using wp-env and sample data."
 ---
 
 # Example: Next.js App Router using the Fetch API
 
-# Table of Contents
-
-- [Overview](#overview)
-    - [Prerequisites](#prerequisites)
-    - [Project Structure](#project-structure)
-    - [Features](#features)
-    - [Screenshots](#screenshots)
-
-- [Running the Example with wp-env](#running-the-example-with-wp-env)
-    - [Prerequisites](#prerequisites-1)
-    - [Setup Repository and Packages](#setup-repository-and-packages)
-    - [Build and Start the Application](#build-and-start-the-application)
-    - [Command Reference](#command-reference)
-    - [Database Access](#database-access)
-
-# Overview
-
 An example headless WordPress application using Next.js App Router and the fetch API to fetch data from WordPress using WPGraphQL It showcases different data fetching strategies, state management techniques, and modern web development patterns in a real-world application context. This also contains a full example using wp-env and sample data.
 
 ## Prerequisites
diff --git a/examples/next/client-multisite-app-router-fetch-data/README.md b/examples/next/client-multisite-app-router-fetch-data/README.md
@@ -1,27 +1,10 @@
 ---
-title: "Example: Multisite Next.js App Router using the Fetch API"
+title: "Multisite Next.js App Router using the Fetch API"
 description: "An example mulitsite headless WordPress application using Next.js App Router and the fetch API to fetch data from WordPress using WPGraphQL. It showcases different data fetching strategies, state management techniques, and modern web development patterns in a real-world application context. This also contains a full example using wp-env and sample data."
 ---
 
 # Example: Multisite Next.js App Router using the Fetch API
 
-# Table of Contents
-- [Overview](#overview)
-  - [Prerequisites](#prerequisites)
-  - [Project Structure](#project-structure)
-  - [Features](#features)
-  - [Screenshots](#screenshots)
-- [Running the Example with wp-env](#running-the-example-with-wp-env)
-  - [Prerequisites](#prerequisites-1)
-  - [Setup Repository and Packages](#setup-repository-and-packages)
-  - [Build and Start the Application](#build-and-start-the-application)
-  - [Command Reference](#command-reference)
-  - [Database Access](#database-access)
-  - [Adding More Sites to the Multisite Examples](#adding-more-sites-to-the-multisite-examples)
-
-
-# Overview
-
 An example mulitsite headless WordPress application using Next.js App Router and the fetch API to fetch data from WordPress using WPGraphQL. It showcases different data fetching strategies, state management techniques, and modern web development patterns in a real-world application context. This also contains a full example using wp-env and sample data.
 
 ## Prerequisites
diff --git a/examples/next/custom-sitemap-apollo/README.md b/examples/next/custom-sitemap-apollo/README.md
@@ -1,12 +1,10 @@
 ---
-title: "Example: Create a custom WordPress sitemap with WPGraphQL and Apollo Client"
+title: "Create a custom WordPress sitemap with WPGraphQL and Apollo Client"
 description: "This example demonstrates how to generate a custom sitemap in a headless WordPress application using the Next.js framework. The example app fetches data from WordPress using Apollo Client and WPGraphQL. Since WPGraphQL doesn't support sitemaps natively, we are extending it with a custom plugin, which is included in this example as well. This plugin exposes new fields to fetch the sitemap index, with data identical to what's rendered on the native WordPress sitemap. Another field exposed by this plugin allows you to request sitemap subpages by specifying the types and pages. The plugin also adds featured image data, enabling you to create [Image Sitemaps](https://developers.google.com/search/docs/crawling-indexing/sitemaps/image-sitemaps)."
 ---
 
 # Example: Create a custom WordPress sitemap with WPGraphQL and Apollo Client
 
-## Overview
-
 This example demonstrates how to generate a custom sitemap in a headless WordPress application using the Next.js framework. The example app fetches data from WordPress using Apollo Client and WPGraphQL. Since WPGraphQL doesn't support sitemaps natively, we are extending it with a custom plugin, which is included in this example as well. This plugin exposes new fields to fetch the sitemap index, with data identical to what's rendered on the native WordPress sitemap. Another field exposed by this plugin allows you to request sitemap subpages by specifying the types and pages. The plugin also adds featured image data, enabling you to create [Image Sitemaps](https://developers.google.com/search/docs/crawling-indexing/sitemaps/image-sitemaps).
 
 The example includes a wp-env setup, which will allow you to build and start this example quickly. With this wp-env setup, you don't need to have a separate WordPress instance or demo data to inspect the example.
diff --git a/examples/next/custom-sitemap-vanilla-wpgraphql/README.md b/examples/next/custom-sitemap-vanilla-wpgraphql/README.md
@@ -1,12 +1,10 @@
 ---
-title: "Example: Create a custom WordPress sitemap with vanilla WPGraphQL and Apollo Client"
+title: "Create a custom WordPress sitemap with vanilla WPGraphQL and Apollo Client"
 description: "This example demonstrates how to generate a custom sitemap in a headless WordPress application using the Next.js framework. The example app fetches data from WordPress using Apollo Client and WPGraphQL. This example is using only the existing WPGraphQL endpoints, without extending it."
 ---
 
 # Example: Create a custom WordPress sitemap with vanilla WPGraphQL and Apollo Client
 
-## Overview
-
 This example demonstrates how to generate a custom sitemap in a headless WordPress application using the Next.js framework. The example app fetches data from WordPress using Apollo Client and WPGraphQL. This example is using only the existing WPGraphQL endpoints, without extending it.
 
 The example includes a wp-env setup, which will allow you to build and start this example quickly. With this wp-env setup, you don't need to have a separate WordPress instance or demo data to inspect the example.
diff --git a/examples/next/hybrid-sitemap-apollo/README.md b/examples/next/hybrid-sitemap-apollo/README.md
@@ -4,7 +4,7 @@ description: "A Next.js application that fetches and transforms WordPress sitema
 ---
 
 # WordPress to Next.js Sitemap Integration
-## Overview
+
 A Next.js application that fetches and transforms WordPress sitemaps with clean URL formatting, providing a seamless integration between WordPress content and Next.js frontend.
 
 ## Features
diff --git a/examples/next/proxied-graphql-debug/README.md b/examples/next/proxied-graphql-debug/README.md
@@ -5,7 +5,6 @@ description: "A debugging utility for proxied GraphQL APIs within WordPress envi
 
 # WordPress GraphQL Proxy Debugger
 
-## Overview
 A debugging utility for proxied GraphQL APIs within WordPress environments, offering enhanced query inspection, request/response logging, and real-time query complexity estimation.
 
 ## Features
diff --git a/examples/next/proxied-sitemap-apollo/README.md b/examples/next/proxied-sitemap-apollo/README.md
@@ -4,7 +4,7 @@ description: "This solution provides a proxied sitemap for a WordPress site that
 ---
 
 # WordPress to Next.js Sitemap Integration
-## Overview
+
 This solution provides a proxied sitemap for a WordPress site that integrates seamlessly with a Next.js frontend. The WordPress XML sitemaps are fetched, and the domain URLs within the sitemap are replaced with the frontend domain (headless site URL). These transformed sitemaps are then served via a Next.js API route, ensuring SEO-friendly URLs that point to your frontend domain.
 
 
diff --git a/examples/next/render-blocks-pages-router/README.md b/examples/next/render-blocks-pages-router/README.md
@@ -1,5 +1,5 @@
 ---
-title: "Example: Rendering WordPress Blocks in Next.js"
+title: "Rendering WordPress Blocks in Next.js"
 description: "This example demonstrates rendering WordPress Blocks with JSX in a Next.js project. The example includes 16 block components across various categories. Example includes a utility to convert flat blocks data from GraphQL (GQL) response into the hierarchical data structure. Passing this data into BlockRenderer component generates the WordPress content by matching the appropriate blocks and using a default block when block implementation is missing. Default block is also customizable component. Example also gives an option to provide custom HTML parser to render HTML content."
 ---
 
diff --git a/examples/next/wp-theme-rendered-blocks/README.md b/examples/next/wp-theme-rendered-blocks/README.md
@@ -1,5 +1,5 @@
 ---
-title: "Example: WordPress Global Styles in Next.js"
+title: "WordPress Global Styles in Next.js"
 description: "This example demonstrates how to **fetch and apply WordPress Global Styles** in a Next.js project using the `globalStylesheet` GraphQL field. These styles reflect your active theme’s typography, spacing, colors, and layout rules — ensuring that your frontend matches the WordPress editor and theme design."
 ---
 
diff --git a/examples/nuxt/nuxt-headlesswp-gravity-forms/README.md b/examples/nuxt/nuxt-headlesswp-gravity-forms/README.md
@@ -1,5 +1,5 @@
 ---
-title: "Example: Gravity Forms in Headless WordPress with Nuxt/Vue"
+title: "Gravity Forms in Headless WordPress with Nuxt/Vue"
 description: "This example shows you how to wire up a full headless WordPress backend—complete with Gravity Forms, WPGraphQL, and a pre-built \"Questionnaire\" form—alongside a Nuxt 3 front end that dynamically renders your forms using the GraphQL interfaces feature of WPGraphQL for Gravity Forms."
 ---
 
diff --git a/examples/sveltekit/template-hierarchy-data-fetching-urql/README.md b/examples/sveltekit/template-hierarchy-data-fetching-urql/README.md
@@ -3,7 +3,7 @@ title: "SvelteKit Template Hierarchy and Data fetching w/URQL Example"
 description: "In this example we show how to implement the **WordPress Template Hierarchy in SvelteKit** for use with a Headless WordPress backend using WPGraphQL. We use **URQL** for all routing and fetching page content."
 ---
 
-# SvelteKit Template Hierarchy and Data fetching w/URQL Example 🚀
+# SvelteKit Template Hierarchy and Data fetching w/URQL Example
 
 In this example we show how to implement the **WordPress Template Hierarchy in SvelteKit** for use with a Headless WordPress backend using WPGraphQL. We use **URQL** for all routing and fetching page content.
 
@@ -18,6 +18,6 @@ In this example we show how to implement the **WordPress Template Hierarchy in S
 > [!NOTE]
 > When you kill the long running process this will not shutdown the local WP instance, only SvelteKit. You must run `npm run example:stop` to kill the local WP server.
 
-## Trouble Shooting 🛠️
+## Trouble Shooting
 
 To reset the WP server and re-run setup you can run `npm run example:prune` and confirm "Yes" at any prompts.
