Write docs for the @frontity/yoast package
DAreRodz opened this issue · comments
- Code Pull Request: frontity/frontity#548
- Feature discussion: https://community.frontity.org/t/support-for-yoast-plugin-rest-api-fields/2626
The documentation URL linked in the README file of the package is this one (it should be created, doesn't exist yet): https://docs.frontity.org/api-reference-1/frontity-yoast
This package has two options: transformLinks and onlyInSSR. Both are explained in theTSDocs written in types.ts.
BTW, I think it is very important that we don't forget to mention this in the docs: https://community.frontity.org/t/support-for-yoast-plugin-rest-api-fields/2626/29?u=luisherranz
Please add a link to the docs in the package readme once they are available: https://github.com/frontity/frontity/blob/dev/packages/yoast/README.md
You refer to the onlyInSSR option - should that be renderTags? From what I can determine in the feature discussion there was talk of an onlyInSSR option, but I guess this is what renderTags is?
@mburridge I guess we can close this issue 🎉
Closing this as PR #15 has been merged and closed and concludes this issue.