source:

Markdown Style Guide for about.[GitLab.com]
This website was generated by Middleman, a blog-aware Static Site Generator (SSG) widely used by web developers. Markup language is part of the structure of any SSG. It is a system to write documents making them somehow syntactically distinguishable from text. Lightweight markup languages have a simplified and unobtrusive syntax, designed to be easily written within any text editor. That's what we use to write our content. The majority of SSGs use markdown engines for this purpose. Read through our blog post on Modern Static Site Generators to understand how they work.

•For about.[GitLab.com] we use kramdown, which is an advanced Markdown engine with a lot of interesting features that most of the other engines don't have, such as inline attribute lists (IALs), which enable easy styling beyond the standard Markdown options.

•If you never have written a single line in markdown markup, don't worry, it's easy to learn and even easier to use. You'll probably be surprised how handy it is once you get used to it. And you'll miss it whenever the tech you're using doesn't support markdown.

•In most of <GitLab text areas you'll find markdown support. Not all of them run with kramdown, so the markup will not behave equally <"GitLabwide". For GitLab.com, <GitLab CE and GitLab EE text areas, the markdown engine is currently CommonMarker. Here you can find the markdown style guide for them.

•This guide has been made to make it easier for everyone to use kramdown features and save a lot of time writing content for about.[GitLab.com, ]including handbook pages, website pages, blog posts and everything else within the project[ www-GitLab-com.]

•There are different possible syntaxes for most of the markups described below, but this guide is to be considered the standard for about.[GitLab.com.]

#Heading h1
##Heading h2
##Heading h3

Notes:

•We don't use h1 headings, as they already are displayed on every page as its title, and we should not apply more than one h1 per page.
When you use a top level heading, or an

, you’re setting up a semantic relationship between that heading and the remainder of the content on a page, describing what it is about. If you then use a second

on the same page, you’re creating some potential confusion, because someone, or a search engine might see that as the ending of the semantic relationship between the content after the first

and the start of this new

. SEO Guide

•Always start with h2 (##), and respect the order h2 → h3 → h4. Never skip the hierarchy level, such as h2 → h4.
The six heading elements, H1 through H6, denote section headings. Although the order and occurrence of headings is not constrained by the HTML DTD, documents should not skip levels (for example, from H1 to H3), as converting such documents to other representations is often problematic. W3C

•Always leave a blank space between the hash # and the text next to it, otherwise it won't render properly.
For keeping the text clear and the markdown consistent, jump a line between any heading and its subsequent paragraph.
Paragraphs, breaks, and horizontal lines
Regular paragraphs are obtained by just writing text lines. If you hit enter between two lines, both lines will be joined into a single paragraph, which is called wrapping text. But, if you leave a blank line between them, they will split into two paragraphs.

•In some Git tools, diffs in future MRs may be easier to understand with additional line breaks, however GitLab's web interface as well as many desktop Git tools feature substring change highlighting within lines and side-by-side or similar version comparison so there is no need for artificial line breaks.

•Wrapping Text
Splitting long lines (preferably up to 100 characters) can make it easier to provide feedback on small chunks of text. Do not leave blank spaces after the last word of the line broken within a paragraph, unless you want it to be intentionally broken with a
.

Blockquotes
As Kanye west

We're living the future so
The present is our past

You can get markup for the images attached to the cards by hovering over the image and clicking on "get markup".

Tables:
Right-aligned Value, centered Qty

Item	Value	Qty
Computer	$1600	5
Phone	$12	12
Pipe	$1	234

Block-quote:

This is a blockquote with two paragraphs.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit.

Nested block-quote:

This is the first level of quoting.

This is nested block-quote.

Back to the first level.

Unordered list:

• Red
• Green
• Blue

• Red
• Green
• Blue

• Red
• Green
• Blue

Ordered list:

1. Bird
   1. Parakeet
   2. Parrot
   3. Chicken
2. Dog
3. Cat

(https://www.storiesonboard.com)

source:

Mentor @cryptokannon
@steemcurator01
@steemcurator02
@ngoenyi
@mariita52
@cmp2020
@tralfagar
@fombae