Описание разметки файла README.md

Для описания проектов на GitHub используется README.md, который пишется на языке разметки аля - markdown. Что и как поддерживается расписано ниже.

Разделительная черта
Заголовки
Работа с выделением текста
Включение перевода на новую строку
Использование эмодзи (emoji)
Использование цитирования в тексте
Подсветка кода
Списки
Ссылки
Вставка изображения
Вставка таблиц

Разделительная черта

При использовании

____

получается разделительная черта

⬆️Оглавление

Заголовоки

Всего существует шесть вариантов создать заголовок. Для того, что бы создать заголовок необходимо в начале строки установить символ #.

# Заголовок 1
## Заголовок 2
### Заголовок 3
#### Заголовок 4
##### Заголовок 5
###### Заголовок 6

⬆️Оглавление

Работа с выделением текста

~~Зачеркнутый текст~~

~~Зачеркнутый текст (Strikethrough)~~

Для выделения текста жирным или наклонным и их сочетания можно использовать комбинации * или _

**Жирный текст (bold)**

Жирный текст (bold)

*Наклонный текст (italic)*

Наклонный текст (italic)

***Жирный наклонный текст (bold italic)***

Жирный наклонный текст (bold italic)

__Жирный текст (bold)__

Жирный текст (bold)

_Наклонный текст (italic)_

Наклонный текст (italic)

___Жирный наклонный текст (bold italic)___

Жирный наклонный текст (bold italic)

~~*__Тут странный текст__*~~

~~Тут странный текст~~

⬆️Оглавление

Включение перевода на новую строку

Достаточно в конце строки добавить четыре пробела:

Это две    
строки

Это две
строки

⬆️Оглавление

Использование эмодзи (emoji)

В самом тексте можно использовать эмодзи, например написать вот так:

✅ Это уже сделано
❎ Я не буду это делать
🔲 делать или не делать, вот в чем вопрос?

В оригинале это выглядит так:

:white_check_mark: Это уже сделано    
:negative_squared_cross_mark: Я не буду это делать    
:black_square_button: делать или не делать, вот в чем вопрос?

Список работающих Эмодзи находится тут -> emoji.md

⬆️Оглавление

Использование цитирования в тексте

> Цитата (уровень 1)    
> > Вложенная цитата (уровень 2)    
> > > Вложенная цитата (уровень 3)    

> > Продолжение цитаты (уровень 2)    

> Продолжение цитаты (уровень 1)

Цитата (уровень 1)

Вложенная цитата (уровень 2)

Вложенная цитата (уровень 3)

Продолжение цитаты (уровень 2)

Продолжение цитаты (уровень 1)

Внешний вид, конечно, не очень но может и пригодится.

⬆️Оглавление

Подсветка кода

Если нужно выделить слово или фразу внутри строки, то используются одинарные обратные апострофы (`), для выделения в блоки - тройные. Дополнительно можно задавать язык кода внутри блока:

Можно использовать light-code внутри строки, а можно выделять блоками.

Пример блока для C#

using MarkdownSharp;
using MarkdownSharp.Extensions.Mal;

Markdown mark = new Markdown();

// Short link for MAL - 
// http://myanimelist.net/people/413/Kitamura_Eri => mal://Kitamura_Eri
mark.AddExtension(new Articles()); 
mark.AddExtension(new Profile());

mark.Transform(text);

Пример блока для Python

from timeit import Timer

tmp = "Python 3.2.2 (default, Jun 12 2011, 15:08:59) [MSC v.1500 32 bit (Intel)] on win32."

def case1(): # А. инкрементальные конкатенации в цикле
    s = ""
    for i in range(10000):
        s += tmp

def case2(): # Б. через промежуточный список и метод join
    s = []
    for i in range(10000):
        s.append(tmp)
    s = "".join(s)

def case3(): # В. списковое выражение и метод join
    return "".join([tmp for i in range(10000)])

def case4(): # Г. генераторное выражение и метод join
    return "".join(tmp for i in range(10000))

for v in range(1,5):
    print (Timer("func()","from __main__ import case%s as func" % v).timeit(200))

⬆️Оглавление

Списки

Маркированный

Задать маркированный список можно несколькими символами -, + или *:

- Уровень списка 1. Пункт 1.
- Уровень списка 1. Пункт 2.
- Уровень списка 1. Пункт 3.

Уровень списка 1. Пункт 1.
Уровень списка 1. Пункт 2.
Уровень списка 1. Пункт 3.

+ Уровень списка 1. Пункт 1.
+ Уровень списка 1. Пункт 2.
+ Уровень списка 1. Пункт 3.

Уровень списка 1. Пункт 1.
Уровень списка 1. Пункт 2.
Уровень списка 1. Пункт 3.

* Уровень списка 1. Пункт 1.
* Уровень списка 1. Пункт 2.
* Уровень списка 1. Пункт 3.

Уровень списка 1. Пункт 1.
Уровень списка 1. Пункт 2.
Уровень списка 1. Пункт 3.

Можно создавать многоуровневые списки. Каждый уровень отделяеться четыремя (4) пробелами.:

- Уровень списка 1. Пункт 1.
    - Уровень списка 2. Пункт 1.
- Уровень списка 1. Пункт 2.
    - Уровень списка 2. Пункт 1.
    - Уровень списка 2. Пункт 2.
- Уровень списка 1. Пункт 3.
    - Уровень списка 2. Пункт 1.
        - Уровень списка 3. Пункт 1.
        - Уровень списка 3. Пункт 2.
           - Уровень списка 4. Пункт 1.

Уровень списка 1. Пункт 1.
- Уровень списка 2. Пункт 1.
Уровень списка 1. Пункт 2.
- Уровень списка 2. Пункт 1.
- Уровень списка 2. Пункт 2.
Уровень списка 1. Пункт 3.
- Уровень списка 2. Пункт 1.
  - Уровень списка 3. Пункт 1.
  - Уровень списка 3. Пункт 2.
    - Уровень списка 4. Пункт 1.

Каждый уровень отделяеться двумя пробелами.

Нумерованный

Для Githib работа с нумерованными списками выглядит, очень интересно. Каждый уровень отделяеться четыремя (4) пробелами.

1. Первый уровень 1
    1. Второй уровень 1
        1. Третий уровень 1
            1. Четвертный уровень 1
                1. Пятый уровень 1
                    1. Шестой уровень
                        1. Седьмой уровень
                            1. Седьмой уровень
2. Первый уровень 2
2. Первый уровень (должно быть 3)
4. Первый уровен 4

Первый уровень 1
1. Второй уровень 1
  1. Третий уровень 1
    1. Четвертный уровень 1
      1. Пятый уровень 1
        
        Шестой уровень
        
        Седьмой уровень
        
        Седьмой уровень
Первый уровень 2
Первый уровень (должно быть 3)
Первый уровен 4

Смешанные списки.

При использование смешанных списков нужно очень внимательно следить на нумерацией. Лучше так-же как и в нумерованных использовать четыре (4) пробела для отделения уровня.

1. Первый уровень "нумерованный" - 1
    * Второй уровень "маркер"
        + Третий уровень "маркер"
        - Третий уровень "маркер"
        1. Третий уровень "нумерованный" - 1
            1. Четвертный уровень "нумерованный" - 1
                1. Пятый уровень "нумерованный" - 1
                    1. Шестой уровень "нумерованный" - 1
                        1. Седьмой уровень "нумерованный" - 1
                        * Седьмой уровень "маркер"
                        2. Седьмой уровень "нумерованный" - 1 (нарушена нумерация, новая нумерация 1)
                        3. Седьмой уровень "нумерованный" - 1 (нарушена нумерация, новая нумерация 2)
                            1. Восьмой уровень "нумерованный" - 1
2. Первый уровень "нумерованный" - 2
- Первый уровень "нумерованный" - 3
4. Первый уровень "нумерованный" - 4 (нарушена нумерация, новая нумерация 1)
5. Первый уровень "нумерованный" - 5 (нарушена нумерация, новая нумерация 2)

Первый уровень "нумерованный" - 1
- Второй уровень "маркер"
  - Третий уровень "маркер"
  - Третий уровень "маркер"
  1. Третий уровень "нумерованный" - 1
    1. Четвертный уровень "нумерованный" - 1
      1. Пятый уровень "нумерованный" - 1
        
        Шестой уровень "нумерованный" - 1
        
        Седьмой уровень "нумерованный" - 1
        
        Седьмой уровень "маркер"
        
        Седьмой уровень "нумерованный" - 2
        
        Седьмой уровень "нумерованный" - 3
        
        Восьмой уровень "нумерованный" - 1
Первый уровень "нумерованный" - 2

Первый уровень "нумерованный" - 3

Первый уровень "нумерованный" - 4
Первый уровень "нумерованный" - 5

Список задач (Task List)

Можно создавать "Списки задач" для этого необходимо использовать - [ ] для поставленной задачи и - [X] для выполненной задачи.

- [X] Предумать внешний вид резюме.
- [ ] Написать основные категории
- [X] Опубликовать

Предумать внешний вид резюме.
Написать основные категории
Опубликовать

Так же можно создавать многоуровневые списки задач. Каждый уровень отделяеться четыремя (4) пробелами.:

- [X] Задача 1
    - [X] Подзадача 1 для Задачи 1
    - [X] Подзадача 2 для Задачи 1
- [ ] Задача 2
    - [X] Подзадача 1 для Задачи 2
    - [ ] Подзадача 2 для Задачи 2
- [ ] Задача 3
    - [ ] Подзадача 1 для Задачи 3
        - [ ] Подзадача 1 для Подзадача 1 для Задачи 3

Задача 1
- Подзадача 1 для Задачи 1
- Подзадача 2 для Задачи 1
Задача 2
- Подзадача 1 для Задачи 2
- Подзадача 2 для Задачи 2
Задача 3
- Подзадача 1 для Задачи 3
  - Подзадача 1 для Подзадача 1 для Задачи 3

⬆️Оглавление

Ссылки

Либо просто вставить ссылку, либо дополнительно задать текст ссылки (пробела между скобками быть не должно):

Первый вариант вставки ссылок - это просто написать адрес сайта http://sabaka.net

Первый вариант вставки ссылок - это просто написать адрес сайта http://sabaka.net

Второй вариант записывается так [текст ссылки](адрес ссылки)

[sabaka.net](http://sabaka.net)

sabaka.net

⬆️Оглавление

Вставка изображения

![Alt-текст](https://avatars1.githubusercontent.com/u/5384215?v=3&s=460 "Орк")

⬆️Оглавление

Вставка таблиц

| LEFT | CENTER | RIGHT |
|----------------|:---------:|----------------:|
| По левому краю | По центру | По правому краю |
| текст | текст | текст |

LEFT	CENTER	RIGHT
По левому краю	По центру	По правому краю
текст	текст	текст

⬆️Оглавление

Нестандартные расширения

Первое упоминание термина

Диалектизмы — Слова, употребляемые жителями той или иной местности. $Рушник$ (полотенце), $векша$ (белка), $гуторить$ (говорить).

Диалектизмы — Слова, употребляемые жителями той или иной местности. $Рушник$ (полотенце), $векша$ (белка), $гуторить$ (говорить).

Переменная программы

В тексте встречается переменная %variable% из программы.

В тексте встречается переменная %variable% из программы.

Вывод программы или скрипта

<<<
C:\WINDOWS\system32>ping 192.168.0.1

Обмен пакетами с 192.168.0.1 по с 32 байтами данных:
Превышен интервал ожидания для запроса.
<<<

<<< C:\WINDOWS\system32>ping 192.168.0.1

Обмен пакетами с 192.168.0.1 по с 32 байтами данных: Превышен интервал ожидания для запроса. <<<

Список определений

| *** | *** |
|----------------|---------|
| Аллегория | Троп, заключающийся в иносказательном изображении отвлечённого понятия при помощи конкретного жизненного образа. Например, в баснях и сказках хитрость показывается в образе лисы, жадность – в обличии волка, коварство – в виде змеи и т. д. |
| Аллитерация | Повторение одинаковых согласных звуков или звукосочетаний как стилистический приём. Шипенье пенистых бокалов и пунша пламень голубой (Пушкин). |

***	***
Аллегория	Троп, заключающийся в иносказательном изображении отвлечённого понятия при помощи конкретного жизненного образа. Например, в баснях и сказках хитрость показывается в образе лисы, жадность – в обличии волка, коварство – в виде змеи и т. д.
Аллитерация	Повторение одинаковых согласных звуков или звукосочетаний как стилистический приём. Шипенье пенистых бокалов и пунша пламень голубой (Пушкин).

***

Аллегория

Троп, заключающийся в иносказательном изображении отвлечённого понятия при помощи конкретного жизненного образа. Например, в баснях и сказках хитрость показывается в образе лисы, жадность – в обличии волка, коварство – в виде змеи и т. д.

Аллитерация

Повторение одинаковых согласных звуков или звукосочетаний как стилистический приём. Шипенье пенистых бокалов и пунша пламень голубой (Пушкин).

zamabuvaraeu/format-README.md

Описание разметки файла README.md

Оглавление

Разделительная черта

Заголовоки

Работа с выделением текста

Включение перевода на новую строку

Использование эмодзи (emoji)

Использование цитирования в тексте

Подсветка кода

Списки

Маркированный

Нумерованный

Смешанные списки.

Список задач (Task List)

Ссылки

Вставка изображения

Вставка таблиц

Нестандартные расширения

Первое упоминание термина

Переменная программы

Вывод программы или скрипта

Список определений