Search index refreshed
A concise example of a news item with pull request metadata. It remains short enough to render without a collapsed description.
Examples
Default news timeline
Use this snippet:
{% include news.html %}
This renders as:
-
-
Resource table examples expanded
The example dataset now includes a longer news item so the truncation button, Markdown rendering and linked pull request metadata can be reviewed together.
Highlights include:
- inline links to supporting documentation
- a short list rendered inside the description
- enough text to trigger collapsed descriptions in compact news blocks
This kind of entry is useful for release notes, project updates or change summaries that need more than one sentence.
-
Documentation page added
Documentation news can include an internal link when readers need more context.
-
Theme release published
A short news item demonstrating the default compact news layout.
News timeline with title, caption and truncation
Use this snippet:
{% include news.html title=true truncate=true caption=true caption_url="/news" %}
This renders as:
What's new?
-
Search index refreshed
A concise example of a news item with pull request metadata. It remains short enough to render without a collapsed description.
-
Resource table examples expanded
The example dataset now includes a longer news item so the truncation button, Markdown rendering and linked pull request metadata can be reviewed together.
Highlights include:
- inline links to supporting documentation
- a short list rendered inside the description
- enough text to trigger collapsed descriptions in compact news blocks
This kind of entry is useful for release notes, project updates or change summaries that need more than one sentence.
-
Documentation page added
Documentation news can include an internal link when readers need more context.
-
Theme release published
A short news item demonstrating the default compact news layout.
Parameters
title: Show What’s new? as a heading (trueorfalse).caption: Show the “For more news please visit our news page.” caption (trueorfalse).caption_url: Use a custom URL when the main news page is not served at/news.truncate: Collapse descriptions longer than 40 words behind a button (trueorfalse).limit: Limit the number of news items shown.