Skip to content

Commit e5a770d

Browse files
committed
Create index.md for docs. Fixes #458
1 parent 35cd7ed commit e5a770d

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

docs/index.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Introduction
2+
3+
## What is the Headless WordPress Toolkit?
4+
5+
The Headless WordPress Toolkit is a modern, framework-agnostic toolkit for building headless WordPress applications. It provides a collection of plugins, packages, and examples to help developers make WordPress a better headless CMS.
6+
7+
Our goal is to provide developers with the tools they need to build fast, scalable, and secure headless applications with WordPress, without being tied to a specific frontend framework.
8+
9+
## Plugins
10+
11+
The toolkit includes several WordPress plugins to enhance the headless experience.
12+
13+
| Plugin | Description |
14+
|--------|-------------|
15+
| [`hwp-previews`](../plugins/hwp-previews/) | Headless Previews solution for WordPress: fully configurable preview URLs via the settings page which is framework agnostic. |
16+
| [`wpgraphql-webhooks`](../plugins/wpgraphql-webhooks/) | Extends WPGraphQL to support webhook subscriptions and dispatching for headless WordPress environments. |
17+
| [`wpgraphql-logging`](../plugins/wpgraphql-logging/) | Logging for WPGraphQL requests with granular lifecycle events and Monolog integration. |
18+
| [`wpgraphql-debug-extensions`](../plugins/wpgraphql-debug-extensions/) | Advanced debugging, performance analysis, and metric collection for WPGraphQL. |
19+
20+
You can find more information about installation in the [plugins documentation](../plugins/README.md).
21+
22+
## Packages
23+
24+
We provide NPM packages that can be used in your frontend applications. All packages use vanilla ES Modules with no build step.
25+
26+
- [`@wpengine/hwp-toolbar`](../packages/toolbar/) — in active development (not yet published)
27+
28+
> [!NOTE]
29+
> No packages are published to npm yet. These are pre-release and subject to change.
30+
31+
## Examples
32+
33+
This project contains a wide variety of examples demonstrating how to use the Headless WordPress Toolkit with different frameworks like Next.js, Astro, SvelteKit, and Nuxt.
34+
35+
Most examples include a `wp-env` setup, allowing you to fully configure a headless application with a single command.
36+
37+
For a full list of examples and how to run them, please see the [examples documentation](../examples/README.md).

0 commit comments

Comments
 (0)