Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vernaillen committed Sep 21, 2024
1 parent 25dc4fd commit c356a13
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,19 @@ It will render the content as is it returned by the WordPress GraphQL API.
By default the GraphQL API returns the content of the page as an HTML string. When using WPNuxt Core this content is rendered as is, with the help of the [vue-sanitize-directive](https://github.com/leopiccionia/vue-sanitize-directive){target=_blank} to make sure we get clean HTML.

Hovever, if you want to use and customise separate vue components to render Gutenberg blocks, you can use the [WPNuxt Blocks](/blocks) plugin.


## WPNuxt Modules + required WordPress plugin(s)

| WPNuxt Module | Required WordPress Plugins |
| ---------------- | ----------------------------- |
| @wpnuxt/core | WPGraphQL |
| @wpnuxt/blocks | WPGraphQL Content Blocks |
| @wpnuxt/auth | WPGraphQL CORS |


ideas for future modules:

| @wpnuxt/yoastseo | Yoast SEO + Add WPGraphQL SEO |
| @wpnuxt/wpml | WPML + WPML WPGraphql |
| @wpnuxt/acf | ACF + WPGraphQL for ACF |
12 changes: 12 additions & 0 deletions docs/1.getting-started/4.components.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Components
description:
---

## WPContent

```vue
<WPContent :node="page" />
```

The node passed to the WPContent component must be of type NodeWithContentEditorFragment or NodeWithEditorBlocksFragment.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit c356a13

Please sign in to comment.