Skip to content

Commit 906c8ec

Browse files
moonmeistermoonmeister
committed
refactor: change to md and frontmatter
1 parent ceac43e commit 906c8ec

File tree

44 files changed

+241
-281
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+241
-281
lines changed

docs/explanation/apollo-client-basics/index.mdx renamed to docs/explanation/apollo-client-basics/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
export const metadata = {
2-
title: "Apollo Client Basics",
1+
---
2+
title: "Apollo Client Basics"
33
description:
4-
"Learn about core Apollo Client concepts like queries, fragments, mutations, and caching as they relate to Faust.js and WordPress.",
5-
};
4+
"Learn about core Apollo Client concepts like queries, fragments, mutations, and caching as they relate to Faust.js and WordPress."
5+
---
66

77
Faust.js uses `@apollo/client` under the hood to perform GraphQL operations against your WordPress backend. Having a solid understanding of Apollo Client queries, fragments, and mutations will help you get the most out of Faust.js.
88

docs/explanation/blocks-faq/index.mdx renamed to docs/explanation/blocks-faq/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
export const metadata = {
2-
title: "Blocks FAQ",
3-
description: "Frequently asked questions about Blocks.",
4-
};
1+
---
2+
title: "Blocks FAQ"
3+
description: "Frequently asked questions about Blocks."
4+
---
55

66
## _"What if the block is missing some attributes?"_
77

docs/explanation/deploy-your-app/index.mdx renamed to docs/explanation/deploy-your-app/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
export const metadata = {
2-
title: "Deploying Your App",
3-
description:
4-
"Explains the various options for deploying your Faust.js App to production.",
5-
};
1+
---
2+
title: "Deploying Your App"
3+
description: "Explains the various options for deploying your Faust.js App to production."
4+
---
65

76
The following explains the various options for deploying your Faust.js App to production.
87

docs/explanation/index.mdx renamed to docs/explanation/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
export const metadata = {
2-
title: "Explanation",
3-
description:
4-
"High-level conceptual guides that provide background information and understanding of Headless WordPress development.",
5-
};
1+
---
2+
title: "Explanation"
3+
description: "High-level conceptual guides that provide background information and understanding of Headless WordPress development."
4+
---
65

76
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, you are in the right place.
87

docs/explanation/migrate-from-wp-graphql-gutenberg/index.mdx renamed to docs/explanation/migrate-from-wp-graphql-gutenberg/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
export const metadata = {
2-
title: "Migrate From WPGraphQL Gutenberg",
3-
description:
4-
"Migrate from wp-graphql-gutenberg to wp-graphql-content-blocks. This guide covers differences between the two plugins, reasons for migration, and step-by-step instructions for updating your GraphQL queries and block structures to ensure compatibility with Faust.js and modern WPGraphQL best practices.",
5-
};
1+
---
2+
title: "Migrate From WPGraphQL Gutenberg"
3+
description: "Migrate from wp-graphql-gutenberg to wp-graphql-content-blocks. This guide covers differences between the two plugins, reasons for migration, and step-by-step instructions for updating your GraphQL queries and block structures to ensure compatibility with Faust.js and modern WPGraphQL best practices."
4+
---
65

76
With [`wp-graphql-gutenberg`](https://github.com/pristas-peter/wp-graphql-gutenberg) being sunset you may find yourself needing to move to the improved [`wp-graphql-content-blocks`](https://github.com/wpengine/wp-graphql-content-blocks) plugin.
87

docs/explanation/migrating-to-typescript/index.mdx renamed to docs/explanation/migrating-to-typescript/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
export const metadata = {
2-
title: "Migrating to TypeScript",
3-
description:
4-
"Guide for migrating existing Next.js pages to TypeScript in a Faust.js project with resources and references.",
5-
};
1+
---
2+
title: "Migrating to TypeScript"
3+
description: "Guide for migrating existing Next.js pages to TypeScript in a Faust.js project with resources and references."
4+
---
65

76
If you have existing Next.js pages that you want to migrate to TypeScript, you can follow the [official TypeScript Docs](https://www.typescriptlang.org/docs/handbook/migrating-from-javascript.html) for general TypeScript migration tips.
87

docs/explanation/react-components-to-blocks/index.mdx renamed to docs/explanation/react-components-to-blocks/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
export const metadata = {
2-
title: "React Components to Blocks",
3-
description:
4-
"Create blocks in your Next.js app that also work in the WordPress Block Editor.",
5-
};
1+
---
2+
title: "React Components to Blocks"
3+
description: "Create blocks in your Next.js app that also work in the WordPress Block Editor."
4+
---
65

76
The `@faustwp/block-editor-utils` package provides helper functions for converting React components into blocks. This means you can use the same components in both places—your Next.js app and the WordPress Block Editor.
87

docs/explanation/telemetry/index.mdx renamed to docs/explanation/telemetry/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
export const metadata = {
2-
title: "Telemetry",
3-
description:
4-
"Information about Faust's anonymous telemetry data collection, what data is collected, and how to opt out.",
5-
};
1+
---
2+
title: "Telemetry"
3+
description: "Information about Faust's anonymous telemetry data collection, what data is collected, and how to opt out."
4+
---
65

76
Faust collects completely anonymous telemetry data about general usage. Participation in this anonymous program is optional. For more information on how we handle this data, please read our [Privacy Policy](/privacy-policy).
87

docs/how-to/authentication/index.mdx renamed to docs/how-to/authentication/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
export const metadata = {
2-
title: "Auth",
3-
description:
4-
"Guide to implementing authentication in your Next.js app using Faust.js toolkit features.",
5-
};
1+
---
2+
title: "Auth"
3+
description: "Guide to implementing authentication in your Next.js app using Faust.js toolkit features."
4+
---
65

76
Understanding authentication is crucial for protecting your application's data. This page will guide you through implementing features from the Faust.js toolkit into your Next.js app.
87

docs/how-to/basic-setup/index.mdx renamed to docs/how-to/basic-setup/index.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
export const metadata = {
2-
title: "Basic Setup",
3-
description:
4-
"Step-by-step guide for setting up a WordPress backend and Next.js frontend to use Faust.js toolkit features.",
5-
};
1+
---
2+
title: "Basic Setup"
3+
description: "Step-by-step guide for setting up a WordPress backend and Next.js frontend to use Faust.js toolkit features."
4+
---
65

76
In order to leverage any of the tools in the Faust.js toolkit, some preliminary setup needs to be done. Follow the steps below to get started.
87

0 commit comments

Comments
 (0)