Skip to content

News feed items

Kim Rutherford edited this page Jun 24, 2024 · 15 revisions
  • new PomBase items should be added to the directory src/docs/news.PomBase/
  • use Markdown format
  • the first line should be a Markdown header eg. ### Some header
  • file names should start with the date in ISO format and end with ".md", eg. 2018-05-22-book-chapter.md

Directives

These directives must appear immediately after the heading. The must be surrounded by html comment characters so the directives aren't displayed in the browser, eg.

<!-- some directive -->

There are two legal directives:

pombase_flags

There are two possible flags:

  • frontpage - this news item should appear on the front page
  • draft - this news item is a draft that shouldn't appear on the web site

Example:

 ### New PomBase genomic region graphics
 <!-- pombase_flags: frontpage -->

newsfeed_thumbnail

To add a thumbnail to the item use:

<!-- newsfeed_thumbnail: browser.png -->

The icon image file should 32x32 pixels and be added to this directory in Git: src/assets/newsfeed/

Front page summaries

To show a summary on the front page with a link to the full post in the news archive, add this magic string on its own line in the Markdown file:

<!-- end-of-summary -->

Only the text before this end-of-summary marker will be shown on the front page.