plugins/feeds: mention summary plugin, render summaries correctly #51
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
By default, the content does not contain a summary. A custom plugin can add that functionality, though. The summary plugin used by Pengutronix is publicly available in flamingo-ptx-blog-engine [1]. It is not part of flamingo itself because it contains theme specifics (ptx-image, ptx-sidebar, ps-gallery). Mention that in the feeds plugin. [1] https://github.com/pengutronix/flamingo-ptx-blog-engine Signed-off-by: Bastian Krause <[email protected]>
Unrendered summaries contain directives such as:
{{ link('content/blog-post.html', 'foo') }}
These do not belong in the final HTML output. A function for summary
rendering can be provided by a custom summary plugin.
Use that if available and make rendered URLs absolute afterwards.
See [1] for an example summary plugin. But note that it contains
theme-related information.
[1] https://github.com/pengutronix/flamingo-ptx-blog-engine/blob/master/flamingo_ptx_blog_engine/summary.py
Signed-off-by: Bastian Krause <[email protected]>
Bastian-Krause
force-pushed
the
bst/feed-summary
branch
from
04b5f52 to
a474abd
Compare
SmithChart
approved these changes
Aug 19, 2024
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.
Unrendered summaries contain directives such as:
These do not belong in the final HTML output. A function for summary rendering can be provided by a custom summary plugin. Use that if available and make rendered URLs absolute afterwards.
While at it, mention that summary functionality is only provided by a plugin. The summary plugin used by Pengutronix is publicly available in the flamingo-ptx-blog-engine repository [1]. It is not part of flamingo itself because it contains theme references (
ptx-image,ptx-sidebar,ps-gallery).[1] https://github.com/pengutronix/flamingo-ptx-blog-engine/blob/master/flamingo_ptx_blog_engine/summary.py