Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 1.45 KB

ARTICLE_CONTENT.md

File metadata and controls

40 lines (31 loc) · 1.45 KB

Filling an article

How to write an article

Any article contains meta-information and content.

Meta information

Meta is at the very top of the article between the two triple dashes ---

---
title: 'This is an <i>example</i> of the use of components'
coverImageAlt: 'Image description'
date: '2019-03-16T05:35:07.322Z'
tag: 'web-development'
---

where

title

Article title. The characters enclosed in the tag <i> on the article page will be displayed in Amita font. Also, this title is used for SEO and Open Graph.

description

A brief description of the article for SEO and Open Graph. If it is not specified, then by default we use the lead (first paragraph) cleared of html tags and MD links, and for the news we use the title of the news.

coverImageAlt

Alt-text for the main image of the article. Alt-text must describe in words what is shown in the image. This is very useful for screen readers.

date

The date the article was created in [ISO-8601] format (https://en.wikipedia.org/wiki/ISO_8601)

tag

Section in the blog to which the article belongs

Content

The article content is consists of markdown, but with some upgrades. In addition to the standard markdown syntax it can use specially prepared custom components that we developed for our blog.

More about custom components.