@hestia-earth/blog

Hestia Blog

This repository contains the raw content of the blog posts written in Markdown language.

Every file under src/posts will be automatically deploy to https://hestia-earth.gitlab.io/hestia-blog domain.

Example:

• src/posts/welcome.md will be deployed to https://hestia-earth.gitlab.io/hestia-blog/welcome
• src/posts/my-first-blog.md will be deployed to https://hestia-earth.gitlab.io/hestia-blog/my-first-blog

Note: only lower chars, dashes (-) and numbers are allowed in the filenames.

Featuring an article

The list of featured articles can be found in the featured.txt file. Each featured article must be on a new line, and must point to the name of the markdown file.

Example:

article1
article2

Writing Guidelines

• Create a new file under src/posts and make sure the filename only uses lowercase letters, numbers and dashes.
• Start the file with a header level 1 using a single #. Example:

# This is the header

This is the content.

## This is a sub-header

The header level 1 will be automatically used as Title for the Post, so please try to keep it short.

The second line (omitting the blank lines) will be used as abstract.

References or citations

To reference or cite another article, please use the following format:

This article references <cite><a href="https://www.nature.com/articles/nature10452">another article</a></cite>

This will be parsed so it is displayed as a reference, using the content inside the link as the full reference name:

1 another article https://www.nature.com/articles/nature10452

Adding metadata

It is possible to add a list of metadata, using the following format:

/<name of metadata> ~Title~

These metadata must be added at the end of the file, one per line. The list of metadata is:

Name	Required	Can be added multiple times
category	Yes	❌
tag	No	✅

Example:

# This is the title

This is the abstract.

/category ~Hestia for dummies~
/tag ~Hestia~
/tag ~Beginners~

Adding images or videos

To add an image or a video to a post:

• add the file under the src/assets folder. Note: you can use sub-directories to organise the files.
• make sure to use a simple name, without special characters. So only letters and numbers, dashes or underscores.
• in the content of the post, use either

  <img src="/blog/assets/<path to the file>" alt="Text to describe the image" height="auto">
  

  or to use videos in different formats

  <video width="320" height="240" controls>
    <source src="/blog/assets/<path to the file>.mp4" type="video/mp4">
    <source src="/blog/assets/<path to the file>.ogg" type="video/ogg">
  </video>