Markdown file formatting

In a project book or on wiki pages, GitFlic allows you to format content using Markdown markup.

• Markdown file formatting
  • Plain text formatting
  • Content formatting
    • # Headings
    • {# Anchor links }
    • TOC – table of contents
    • - Lists
    • > Quoting
    • | Tables |
    • Code fragments
    • Footnotes
    • Images
    • Hyperlinks

Plain text formatting

• ** or __ makes the text bold
• * or _ makes the text italic
• <u></u> underlines text
• \ *escapes* the character after it
• ~~ strikes through text text
• <sup> </sup> creates^superscript
• <sub> </sub> creates_subscript

---

• *** ___ before/after text creates a horizontal divider line

---

Content formatting

# Headings

Headings are indicated using the # symbol. Multiple symbols in a row make the heading smaller – for example, after a # heading you can place subheadings ##, ###, etc.

As an alternative, you may use: - a line of ======== instead of # - a line of -------- instead of ##

Heading level 1
==========================

And heading level 2
--------------------------

{# Anchor links }

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

TOC – table of contents

[TOC] (Table of contents) generates a document outline based on the headings in the document. Anchor links are created for the headings in the file instead of a pointer. See an example at the beginning of this article.

- Lists

You can create an unordered list using the -, +, or * symbols at the beginning of a line. Such lists support indentation: - Item 1 - Item 2 + Subitem 2.1 - Subitem 2.1.1 + Item 3

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

Ordered lists look like this:

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

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

To create a task list, use - [ ] for incomplete items and - [X] for completed ones. - [x] task 1 - [ ] task 2 - [ ] task 3

- [x] task 1
- [ ] task 2
- [ ] task 3

> Quoting

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

A man is immortal thanks to knowledge.

> A man is immortal thanks to knowledge.

| Tables |

You can arrange content in a table using a special structure of | and - symbols.

Example table:

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

Code fragments

You can highlight an inline code fragment using a single ` or double ``.
A multi‑line fragment with a quick‑copy button can be added using ```:

This multi‑line fragment
Can be copied with a button

If necessary, you can specify a programming language or additional details:

``` Markdown

Your text

```

Footnotes

To create a footnote, place a marker after the sentence to which the footnote refers, and a marker before the footnote text.

A simple footnote[^1].

there can be several[^2].

[^1]: first simple footnote
[^2]: To add line breaks inside a footnote, add 2 spaces at the end of the line.  
here is the second line

A simple footnote¹.

there can be several².

Images

To add an image from a project, you can use the following syntax:

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

Or an image from an external source:

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

Hyperlinks

It is possible to add hyperlinks: - to an external resource: GitFlic,

[GitFlic](https://gitflic.ru)

• to an internal page: quick guide

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

• to a marked section of an internal page: anchor links

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

Automated translation!

This page has been automatically translated. The text may contain inaccuracies.

---

1. first simple footnote ↩

2. To add line breaks inside a footnote, add 2 spaces at the end of the line.
   here is the second line ↩