Adds documentation for @frontity/yoast package #15
Conversation
|
|
||
| Defaults to `false`. | ||
|
|
||
| Used if you are using Frontity in decoupled mode. If you are using Frontity in embedded mode this property must be set |
There was a problem hiding this comment.
I would link "embedded mode" to https://github.com/frontity/frontity-embedded
| The `@frontity/yoast` package also requires two Frontity parameters in order to work: | ||
|
|
||
| - `state.frontity.url` : The URL of your site. Usually defined in the `frontity.settings.js` file. | ||
| - `state.source.url` or `state.source.api`: The API where your project is pointing. Defined at [@frontity/wp-source](https://api.frontity.org/frontity-packages/features-packages/wp-source#settings) if you haven't changed your Source. |
There was a problem hiding this comment.
I would just mention state.source.url as we're enouraging people to use only state.source.url to set the WordPress URL in both:
|
|
||
| Possible values: | ||
|
|
||
| - "both" (default) - Render the Yoast meta tags in both the server and the client |
There was a problem hiding this comment.
I would use both & server to highlight strings (instead of quotes)
In this case, as the explanations are about these strings, they will be highlighted from the rest of the explanations (easier to read)
The same applies for the references below
There was a problem hiding this comment.
All the package settings and the php snippet are very well explained. 👏
I don't know if @juanmaguitar has anything more to add regarding the format, but the content is perfect.
As per #9