Skip to content

Markdown File Formatting

In the project book or on GitFlic wiki pages, you can format content using Markdown.

Regular Text Formatting

  • ** or __ makes text bold
  • * or _ makes text italic
  • <u></u> underlines text
  • \ escapes the character immediately after it

Content Formatting

# Headings

Headings are defined using the # symbol. Multiple # symbols in a row create a smaller heading – for example, after a # heading, you can add subheadings using ##, ###, etc.

Alternatively, you can use:

  • a line of ======== for #
  • a line of -------- for ##
First level heading
========================

Second level heading
--------------------------

{# Anchor Links }

By adding {#anchor_name} to a heading line, you can later create a link directly to that section of the page.

- Lists

Create an unordered list using -, +, or * at the beginning of the line. Lists support indentation:

  • Item 1

  • Item 2

  • Item 2.1

    • Item 2.1.1

  • Item 3

- Item 1
- Item 2
 + Item 2.1
  - Item 2.1.1
+ Item 3

Ordered lists look like this:

  1. Item 1

  2. Item 2

  3. Item 2.1

    1. Item 2.1.1
1. Item 1
2. Item 2
 1.  Item 2.1
  1. Item 2.1.1

> Quotes

To add a quote or highlight text, use > at the beginning of the line:

Man is immortal thanks to knowledge.

> Man is immortal thanks to knowledge.

| Tables |

To create a table, use the special structure with | and -.

Table Example:

Symbol Purpose
| Column separator
- Header separator 
| Symbol | Purpose                  |
|--------|--------------------------|
| \|     | Column separator         |
| -      | Header separator         |

Code Fragments code

A single-line code fragment can be highlighted using a single or double backtick (` or ``). A multi-line fragment with a quick copy function can be added using triple backticks (```):

This is a multi-line fragment
You can copy it with a button

You can specify a programming language or additional information:

``` Markdown

Your text

```

Media Content

Images

To add an image from the project, use: Cover

![Caption](../relative/path/to/image.png)


Or an image from an external source: GitFlic

![Caption](https://link_to_image.png)

You can add hyperlinks:

  • to an external resource: GitFlic,
[GitFlic](https://gitflic.ru)

 [quick guide](../../common/guide)

[anchor links](../markdown#anchor)

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.