chore(templates): add custom converter, and comments for static rendering a page #10886
+33
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- instructions to generate static pages at runtime
- add a custom paragraph converter with instructions for removal.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
This PR adds a custom converter to RichText, plus comments in [slug]page.tsx. Currently, it's unclear how to add additional converters to the RichText component, with no instructions or example components on how to add more.
Why?
The templates serve as examples for building a project. Since some users may be new to Payload, they might not know how to add a custom converter. While documentation exists, custom converters are an extremely common need, so including an example is pragmatic.
For [slug]page.tsx, many users encounter build issues due to database access requirements. In some cases, I'd argue generating pages at build time is unnecessary. The added comment preserves the original code while clarifying how to avoid these issues.