SkillBase

MarkDown

Язык текстовой разметки.

Содержание

Введение

Markdown — язык текстовой разметки, созданный писателем и блогером Джоном Грубером. Он предназначен для создания красиво оформленных текстов в обычных файлах формата TXT. Вам не нужны громоздкие процессоры вроде Word или Pages, чтобы создавать документы с жирным или курсивным начертанием, цитатами, ссылками и даже таблицами. Достаточно запомнить простые правила Markdown, и можно писать хоть в «Блокноте». Собвсвенно, даже этот абзац (да и весь репозиторий) написаны на markdown.

Markdown очень удобен не только в качестве язывка разметки документов, но еще и в качетве ведения основных групп конспектов. Так, например, сервис для ведения заметок - Obsidian (аналог notion, но с репощиториями на внешних облачных сервисах) целиком и полностью рабоатет на Markdown разметке.

README файлы к репозитория GitHub пишуться как раз на markdown. Мало, кто из начинающих разработчкиов уделяет время на написание описания, какого-то комментирования кода в ТЗ или просто в README, а это ведь очень хорошая практика, которая помогает выработать какую-то стабильную структурность в коде и в построении проектов в целом.

Основы разметки

Как и в случае с html (который является языком гипертекстовой разметки страниц), в markdown есть свои теги, которые обозначают разметку. Хотя сложно назвать эти ключевые конструкции тегами, но в целом суть ясна:

Форматирование текста:
```
 **Жирный текст**
 *Курсивный текст*
 ~~Зачеркнутый текст~~

 `Выделеный текст`

 <u>Подчеркнутый текст</u>
```
Причем можно сразу обьеденить несколько стилей для текста и одновременно иметь подчеркнутый и курсивный текст.

Списки можно формировать следующим образом:
- пример 1.1
- пример 1.2
- пример 1.3
```
 - пример 1.1
 - пример 1.2
 - пример 1.3
    
```
- пример 2.1
- пример 2.2
- пример 2.3
```
 - [ ] пример 2.1
 - [x] пример 2.2
 - [x] пример 2.3
    
```
Вставка (изображения, гиперссылкиб куски кода и т.д): Для вставки изображение необходимо иметь либо путь к локальному изображению на компьютере, лобо же просто ссылку на него в интернете:
```
 ![описание картинки](путь/или/ссылка/на/картинку)
```
Для создания гиперссылок используется похожий принцип:
```
 [ссылка](ссылка/на/что-то)
```
В целом, можно даже ссылаться на какие-то отдельные главы и заголовки текущей или другой страницы.

Чтобы вставить какой-то кусок кода с некоторой подсветкой, то необходмо использовать следующую конструкцию:
```
     ```python
         print("hello")
     ```
```
В этом примере создаться блок с кодом и python подстветкой. Можно использовать разные языки программирования, например, java, c++, js и т.д. Если ничего не указать, то подсветки синтаксиса просто не будет.

Иногда требуется использовать специфичные формулы и выражения, возможно математического характера, тогда на помощь приходит LaTeX.

[!NOTE] LaTeX — это система компьютерной верстки, которая позволяет сосредоточиться на содержимом документа.

Вместо ручного распределения текста или формулы по странице, как в других текстовых редакторах, можно просто вводить их, позволив LaTeX заняться остальным.

LaTeX необходим студентам, аспирантам, преподавателям, учёным и любым другим специалистам, для которых важна корректность отображения любых данных.

И, о какая удача, markdown поддерживает интеграцию с LaTeX конструкциями:
\[\omega_{1} = \frac{V_{1}}{R_{1}^2}\]
```
 $$
     \omega_{1} = \frac{V_{1}}{R_{1}^2}
 $$
```
[!IMPORTANT] В контексте LaTeX работа с markdown может быть не совсем уместной, однако даже в самом начале (в заголовке файла) прописать ряд специальных библиотек, которые будут

Таблицы:

Таблицы максимально не удобный формат в markdown. Красивый, эффектный, но максимально неудобный

First Header	Second Header
Content Cell	Content Cell
Content Cell	Content Cell

Выше указан пример таблицы, а вот его код:

    
 First Header  | Second Header
 ------------- | -------------
 Content Cell  | Content Cell
 Content Cell  | Content Cell

Причем мы может управлять элементами выравнивания. По умолчанию стоит выравнивание по середине, но если в заголовках столбцов прописывать:

:---- Выравнивание по левому краю; :---: Выравнивание по центру; ----: Выравнивание по правому краю.

Вроде бы понятно, но лично у меня всегда возникает вопрос построения таблиц

Цитаты:

Цитаты - это одна из тех вещей, которые можно использовать в markdown, но так ли они нужны? На практике я использовал элменты цитирования всего пару раз в жизни. Кто-то находит эти конструкции очень удобными:

Пример обычного цитировая
```
 > Пример обычного цитировая
```
Пример вложенного цитирования

Да, кто можно

И так тоже можно
```
 > Пример вложенного цитирования 
 >> Да, кто можно
 >>> И так тоже можно
```
Выпадающее меню:

Выпадающее dropdown мены уже невозможно сделать без html тегов. Про интеграцию html в markdown я расскажу в следующей главе. Сейчас не стоит в это углубляться, можно просто смотреть на результат:

Отображаемое название
Основной тип интегрированого контента выпадающего меню.
```
 <details>
<summary>Отображаемое название</summary>
 Основной тип интегрированого контента выпадающего меню.
</details>
```

Интеграция с html

HTML является языков гипертекстовой разметки, что означает, что он предназначен для создания документов, описывающих неявные параметры через схему тегов и конструкций сложеных тегов.

Особенностью markdown документов является то, что он поддерживает некоторый html теги напрямую. Однако можно встретить некоторые баги в виде того, что markdown текст после неправильной вставки может, так скажем, сломаться и отображаться неккоректно.

Примеры интеграций:

Перенос на новую стоку:
<br>

Жирный, курсивный, подчеркнутый текст:

<b>Жирный текст</b>
<i>Курсивный текст</i>
<u>Подчеркнутый текст</u>

Наверное это все основные html теги, которые чаще всего встречаются при работе с markdown документами. Никто не запрещает работать с другими тегами, но вопрос эффетивности таких манипуляций остается открытым.

Проблемы с использованием на GitHub Pages

Как уже несколько раз было сказано, GitHub Pages предоставляет возможность выкладывать ваши статьи или заметки на markdown в форме автоматически оптимизированных под разные устройства сайт. Однако, есть некоторые ограничения, которые необходимо учитывать при работе с markdown на GitHub. Так, например, не всегда удается использовать какие-нибудь LaTeX формулы и выражения, но эта проблема, в целом, легко решается подключенем неокторых библиотек и плагинов в заголовке статьи. Вот так:

<head>
    <script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
</head>

И тогда все начинает прекрано работать.