|
|
@@ -0,0 +1,270 @@
|
|
|
+## Описание формата Markdown.
|
|
|
+
|
|
|
+### История:
|
|
|
+Первоначально создан в 2004 году Джоном Грубером и Аароном Шварцем. Многие идеи языка были позаимствованы из существующих соглашений по разметке текста в электронных письмах. Реализации языка Markdown преобразуют текст в формате Markdown в валидный, правильно построенный XHTML и заменяют левые угловые скобки («<») и амперсанды(«&») на соответствующие коды сущностей. Первой реализацией Markdown стала написанная Грубером реализация на PERL, однако спустя некоторое время появилось множество реализаций от сторонних разработчиков. Реализация на Perl распространяется по лицензии типа BSD. Реализации Markdown на различных языках програмирования включены (или доступны в качестве плагина) во многие системы управления содержимым
|
|
|
+Файл MD представляет собой текстовый документ, содержащий простой текст с разметкой Markdown. Это легкий язык разметки с синтаксисом в виде специальных символов, определяющих форматирование, стиль, структуру текста и т.п. Например, для выделения текста курсивом, он должен быть обрамлен символами *, а для указания заголовка первого уровня перед ним вводят знак #.
|
|
|
+
|
|
|
+### Разметка
|
|
|
+Разметка Markdown обычно используется при создании документации (лицензий программ, историй версий, примечаний к релизам, пользовательских инструкций и т.д.), позволяя преобразовывать текст в XHTML для дальнейшей публикации в различных форматах, таких как Rich Text, HTML и других. Файлы MD могут быть открыты во многих текстовых редакторах, например, Notepad++.
|
|
|
+
|
|
|
+- Файлы MD обычно используются для форматирования файлов readme. Они также используются для создания богатого текста с помощью обычного текстового редактора. Файлы MD имеют свои приложения на онлайн-форумах, таких сайтах как GitHub, Reddit, Stack Exchange и т.д., которые используют переработанную версию языка.
|
|
|
+
|
|
|
+- Syntax Markdown может быть написан с использованием специфических символов, обеспечивающих простое форматирование.
|
|
|
+
|
|
|
+### Расширения
|
|
|
+Расширение MD также используется файлами метаданных, в которых хранится информация об отдельном, но связанном с ним файле, который может быть либо документом, либо мультимедийным файлом, либо объектом. Например, файл, называемый eLearning.doc, будет иметь файл мета-данных, называемый eLearning.md. Расширение MD также может использоваться файлами описания машины, которые используются для компиляции программ на Unix системах. Эти файлы используются для хранения шаблонов инструкций для каждой инструкции, поддерживаемой целевой машиной.
|
|
|
+
|
|
|
+# Примеры разметки
|
|
|
+---
|
|
|
+## Заголовки:
|
|
|
+---
|
|
|
+```
|
|
|
+# Заголовок 1
|
|
|
+## Заголовок 2
|
|
|
+### Заголовок 3
|
|
|
+#### Заголовок 4
|
|
|
+```
|
|
|
+# Заголовок 1
|
|
|
+## Заголовок 2
|
|
|
+### Заголовок 3
|
|
|
+#### Заголовок 4
|
|
|
+---
|
|
|
+## Работа с выделением текста
|
|
|
+---
|
|
|
+```
|
|
|
+~~Зачеркнутый текст~~
|
|
|
+```
|
|
|
+~~Зачеркнутый текст~~
|
|
|
+
|
|
|
+```
|
|
|
+**Жирный текст (bold)**
|
|
|
+```
|
|
|
+**Жирный текст (bold)**
|
|
|
+
|
|
|
+```
|
|
|
+*Наклонный текст (italic)*
|
|
|
+```
|
|
|
+*Наклонный текст (italic)*
|
|
|
+
|
|
|
+```
|
|
|
+***Жирный наклонный текст (bold italic)***
|
|
|
+```
|
|
|
+***Жирный наклонный текст (bold italic)***
|
|
|
+
|
|
|
+```
|
|
|
+__Жирный текст (bold)__
|
|
|
+```
|
|
|
+__Жирный текст (bold)__
|
|
|
+
|
|
|
+```
|
|
|
+_Наклонный текст (italic)_
|
|
|
+```
|
|
|
+_Наклонный текст (italic)_
|
|
|
+---
|
|
|
+## Списки
|
|
|
+---
|
|
|
+Задать маркированный список можно несколькими символами -, + или *:
|
|
|
+
|
|
|
+```
|
|
|
+- Уровень списка 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.
|
|
|
+
|
|
|
+```
|
|
|
+* Уровень списка 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.
|
|
|
+```
|
|
|
+- Уровень списка 1. Пункт 1.
|
|
|
+ - Уровень списка 2. Пункт 1.
|
|
|
+- Уровень списка 1. Пункт 2.
|
|
|
+ - Уровень списка 2. Пункт 1.
|
|
|
+ - Уровень списка 2. Пункт 2.
|
|
|
+- Уровень списка 1. Пункт 3.
|
|
|
+ - Уровень списка 2. Пункт 1.
|
|
|
+ - Уровень списка 3. Пункт 1.
|
|
|
+ - Уровень списка 3. Пункт 2.
|
|
|
+
|
|
|
+Каждый уровень отделяется двумя пробелами.
|
|
|
+
|
|
|
+### Нумерованный
|
|
|
+---
|
|
|
+Для 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. Пятый уровень 1
|
|
|
+ 1. Шестой уровень
|
|
|
+ 1. Седьмой уровень
|
|
|
+ 1. Седьмой уровень
|
|
|
+2. Первый уровень 2
|
|
|
+2. Первый уровень (должно быть 3)
|
|
|
+4. Первый уровень 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. Шестой уровень "нумерованный" - 1
|
|
|
+ 1. Седьмой уровень "нумерованный" - 1
|
|
|
+ * Седьмой уровень "маркер"
|
|
|
+ 2. Седьмой уровень "нумерованный" - 1 (нарушена нумерация, новая нумерация 1)
|
|
|
+ 3. Седьмой уровень "нумерованный" - 1 (нарушена нумерация, новая нумерация 2)
|
|
|
+ 1. Восьмой уровень "нумерованный" - 1
|
|
|
+2. Первый уровень "нумерованный" - 2
|
|
|
+- Первый уровень "нумерованный" - 3
|
|
|
+4. Первый уровень "нумерованный" - 4 (нарушена нумерация, новая нумерация 1)
|
|
|
+5. Первый уровень "нумерованный" - 5 (нарушена нумерация, новая нумерация 2)
|
|
|
+### Список задач
|
|
|
+---
|
|
|
+```
|
|
|
+- [X] Придумать внешний вид резюме
|
|
|
+- [ ] Написать основные категории
|
|
|
+- [X] Опубликовать
|
|
|
+```
|
|
|
+- [X] Придумать внешний вид резюме
|
|
|
+- [ ] Написать основные категории
|
|
|
+- [X] Опубликовать
|
|
|
+
|
|
|
+Также можно создавать многоуровневые списки задач. Каждый уровень отделяется четырьмя (4) пробелами:
|
|
|
+```
|
|
|
+- [X] Задача 1
|
|
|
+ - [X] Подзадача 1 для Задачи 1
|
|
|
+ - [X] Подзадача 2 для Задачи 1
|
|
|
+- [ ] Задача 2
|
|
|
+ - [X] Подзадача 1 для Задачи 2
|
|
|
+ - [ ] Подзадача 2 для Задачи 2
|
|
|
+- [ ] Задача 3
|
|
|
+ - [ ] Подзадача 1 для Задачи 3
|
|
|
+ - [ ] Подзадача 1 для Подзадача 1 для Задачи 3
|
|
|
+```
|
|
|
+- [X] Задача 1
|
|
|
+ - [X] Подзадача 1 для Задачи 1
|
|
|
+ - [X] Подзадача 2 для Задачи 1
|
|
|
+- [ ] Задача 2
|
|
|
+ - [X] Подзадача 1 для Задачи 2
|
|
|
+ - [ ] Подзадача 2 для Задачи 2
|
|
|
+- [ ] Задача 3
|
|
|
+ - [ ] Подзадача 1 для Задачи 3
|
|
|
+ - [ ] Подзадача 1 для Подзадача 1 для Задачи 3
|
|
|
+
|
|
|
+### Ссылки
|
|
|
+---
|
|
|
+Либо просто вставить ссылку, либо дополнительно задать текст ссылки (пробела между скобками быть не должно):
|
|
|
+
|
|
|
+`Первый вариант вставки ссылок - это просто написать адрес сайта http://sabaka.net`
|
|
|
+Первый вариант вставки ссылок - это просто написать адрес сайта http://sabaka.net
|
|
|
+
|
|
|
+`Второй вариант записывается так: [текст ссылки](адрес ссылки)`
|
|
|
+
|
|
|
+[sabaka.net](http://sabaka.net)
|
|
|
+Вставка изображения
|
|
|
+``
|
|
|
+
|
|
|
+---
|
|
|
+### Вставка таблиц
|
|
|
+---
|
|
|
+```
|
|
|
+| LEFT | CENTER | RIGHT |
|
|
|
+|----------------|:---------:|----------------:|
|
|
|
+| По левому краю | По центру | По правому краю |
|
|
|
+| текст | текст | текст |
|
|
|
+```
|
|
|
+| LEFT | CENTER | RIGHT |
|
|
|
+|----------------|:---------:|----------------:|
|
|
|
+| По левому краю | По центру | По правому краю |
|
|
|
+| текст | текст | текст |
|
|
|
+
|
|
|
+---
|
|
|
+### P.s.
|
|
|
+Хорошей подсказкой для тех кто не знаком с форматом MarkDown будут сайты [Wikipedia](https://www.en.wikipedia.org/wiki/Markdown) и [GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
|
