Document glob() loader deferRender option#14208
Conversation
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
Preview deployment ✅ Deployment complete!
|
yanthomasdev
left a comment
There was a problem hiding this comment.
Thanks @matthewp, I have a suggestion and a comment for you!
|
|
||
| Whether to defer rendering of renderable entries (such as Markdown) until they are rendered in a page, instead of rendering them eagerly during content sync. | ||
|
|
||
| By default, the `glob()` loader renders each Markdown entry during sync and stores the resulting HTML in the data store. This allows the rendered content to be cached and reused across builds. However, for large collections whose rendered output is much larger than the source, storing all this rendered HTML in memory at once can cause your build to run out of memory. |
There was a problem hiding this comment.
the
glob()loader renders each Markdown entry during sync and stores the resulting HTML in the data store.
would this mean this has some interaction with the retainBody option? Like, is setting one false/true change how the other works? I am not super familiar with those options, so I don't know for sure, but if there's any sort of interaction or weird combination of both you should avoid maybe we can add some information about it here!
There was a problem hiding this comment.
Overall this looks good but Yan pointed out two things that seem a little unclear to me: is MDX affected? And how this works when retainBody is set? Does this affects existing docs?
I also made a suggestion to lighten the sentence around "render" a bit. And, I think the last sentence should be one of the first thing we say (ie. "oh, I'm only using data entries, I don't need to read the whole description" vs "is JSON a renderable entry? I should read everything!").
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Documents the new
deferRenderoption for theglob()content loader.Implementation: withastro/astro#17302