Skip to content

ProteinsWebTeam/interpro-blog

Repository files navigation

InterPro blog

Using Jekyll and served using GitHub pages see blog.

Used on the InterPro website to display the latest blog posts.

Recommended format for the blog post

The front matter for the post content should have the following data which are used by the InterPro website to render them.

published
layout
category
author
excerpt
image_category

Options

Published is either true or false depending on the post's published status.

Layout is post by default.

The following values can be given to the Category option

  • interpro
  • focus

Author is optional.

Excerpt is the short extract to show about the post.

Image_category is for the InterPro website to show images while rendering the blog posts accordingly. The following options are considered.

  • General
  • Technical
  • Biological

Steps to create a new blog post

  1. Give the images to be used in the blog post meaningful names (not figure1, figure2...), using only lower case and no space (replace by _)
  2. Upload images to be used in the blog post to the assets/media/images/posts folder (click on the Add file button)
  3. Log into https://prose.io/ with your github identifiers and go into the ProteinsWebTeam/interpro-blog/posts folder
  4. Click on New file, the file name format should be [date-of-publication]-[blog-post-title-with-dash-between-words].md
  5. Add text and images to the article, rendering can be viewed by clicking on the eye icon on the right hand side, go back to editing by clicking on the pen icon
  6. Add metadata by clicking on the corresponding icon, this should contain at least the following (see Recommended format for the blog post above for more details):
    layout:
    category:
    image_category:
    author:
    
  7. Go back to the edit mode and click on the "Unpublished" text in the top menu to make the blog post available publicly
  8. Click on the save button to commit the changes on github