Markdown, вероятно, лучший способ делать заметки на ПК. Объясняем, как им пользоваться

Для ведения заметок на компьютере многие из нас знают типичный вариант: Word или LibreOffice Writer. Это хороший вариант для некоторых сценариев, но если мы хотим делать заметки, делать это быстро, сохранять их в определенном формате и открывать в не очень тяжелой программе просмотра, вероятно, лучше всего использовать так называемый уценка. Здесь мы объясним, что это такое, как «размечается» текст и назовем некоторые редакторы/просмотрщики, которые стоят в Linux.

Маркдаун – это легкая разметка, целью которого является максимизация читабельности и простоты публикации, как во входной, так и в выходной форме. Как и HTML, Markdown отображает текст по-разному в зависимости от используемой нами разметки, например, жирным шрифтом или курсивом. Он был создан Джоном Грубером и покойным Аароном Шварцем, и, не углубляясь в его историю, мы собираемся объяснить, как его использовать.

Как создавать документы Markdown

Создание документа Markdown — это то, что мы можем сделать это с помощью любого текстового редактора. То же самое и в HTML, но Markdown писать проще. В HTML используются теги ввода и вывода, и во всех случаях они имеют символы меньше (), что не очень удобно для набора текста, по крайней мере, на испанской клавиатуре. Многие знаки, которые мы будем использовать в Markdown, также необходимо размещать до и после каждого слова, но использование двух звездочек — это не то же самое, что символы, используемые в HTML. Единственное, что вам нужно, помимо разметок, это сохранить файл с расширением .md или .markdown.

уценка У него не так много опций, как у HTML., но он и не собирается этого делать. В Интернете мы можем найти некоторые из них, которые могут не поддерживаться программой просмотра документов, совместимой с Markdown, но наиболее часто используемые из них:

Пространства в Markdown

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

Заголовки заголовков

В HTML они известны как ч1-ч6. Семантически они должны использоваться как компоненты индекса; Вам не обязательно использовать их для размещения текста большего или меньшего размера. Теоретически h1 должен быть только заголовком страницы, h2 — частью h1, h3 — частью h2 и так далее. Например, раздел «Как создавать документы Markdown» в этой статье — это h2, который находится в общей статье с h1, а «Заголовки заголовков» и то, что последует, будет h3, которые являются частью раздела «Как они создаются».

В HTML это будет тег TEXT, а в Markdown — с двумя решётками впереди:

## Это будет h2

Количество контактных площадок указывает на номер заголовка, максимальное количество — 6.

Жирный, курсив, зачеркивание и выделение

Текст выделен жирным шрифтом (b o сильный в HTML) и курсив (i o em в HTML) выглядят очень похожими, настолько, что это может сбить с толку. можно поставить жирный текст, окружающий его двумя подчеркиваниямии курсивом с подчеркиванием с каждой стороны. Таким образом, три подчеркивания сделают текст жирным и курсивом. И точно так же со звездочками.

Чтобы избежать путаницы, я бы рекомендовал использовать подчеркивание для курсива и две звездочки для жирного шрифта:

**жирный шрифт**
 _курсив_

В некоторых программах просмотра это может не поддерживаться, но вы можете зачеркнуть текст, поместив усы Ñ спереди и сзади дважды (~~) и выделить его как маркером с двумя одинаковыми символами спереди и сзади (==) .

~~Вычеркнуто~~
==Выделено==

Я не вижу выделенного в VSCode или некоторых программах просмотра Linux, но вижу его в заметках браузера Vivaldi.

Если вам интересно, как подчеркнуть, то, как ни странно, в Markdown этого нет. Если вам нужно подчеркнуть текст, лучше всего использовать HTML-тег подчеркнутый текст.

Мощность и индекс

Если мы хотим поставить число повышено до другого, то есть степень, можно сделать, поставив первое число, за которым следует циркумфлекс (^), а затем степень: 2^4 будет означать 2⁴. Есть способы поставить число на противоположной стороне (индекс), но, как и текст-маркер, он поддерживается не всеми процессорами. Это достигается с помощью усов Ñ с каждой стороны текста или цифры: h~2~или выглядит h₂или (если его не видно, представьте, что 2 ниже).

Абзацы

обычно нет необходимости использовать разметку для абзацев, но вам нужно знать пару вещей. У них есть так называемый жесткий разрыв, и поначалу нельзя поставить такой текст, который можно было бы увидеть в стихотворении:

Один день в январе(пробел)(пробел)
Похоже, хороший день (пространство) (пространство)
Потрясающая поэзия (космос)
Блогер написал (пробел)(пробел)

В предыдущем тексте Markdown расставляет всё по порядку, но весь фокус в том, чтобы поставить два пробела в конце каждой строки. Таким образом, он уважает то, что мы ищем. В качестве альтернативы вы можете добавить обратную косую черту, и это рекомендуется, если вы хотите разместить блоки строк одного формата (жирный, курсив...) только с двумя символами в начале и двумя в конце всего блока.

Списки

В HTML существует как минимум три типа списков: упорядоченные (с числами впереди), неупорядоченные (с точками впереди) и определения. ol, ul y dl в HTML соответственно. В Markdown у нас есть то же самое, и они будут созданы так:

Неупорядоченные списки

С черточкой впереди:

- Первый элемент
- Второй элемент
- Третий элемент

и еще со звездочкой:

*Это будет первым
* В эту секунду
*И третий

или дополнительные символы:

+ Первый пункт
+ Второй пункт
+ Третий пункт

Если мы хотим создать подсписок, мы поместим два предыдущих символа вместо одного, три для подсписка и так далее.

- Купить
- - Молоко
- - Печенье

Также это можно сделать с отступом (несколько пробелов).

упорядоченные списки

Упорядоченные списки создаются путем помещения числа, за которым следует точка, а затем элемент:

1. Первое, что нужно сделать
2. Отсюда следует
3. И это позже

Или также со скобкой вместо точки:

1) Элемент 1
2) Элемент 2

Чтобы добавить подсписки, вам нужно добавить отступы, в зависимости от уровня, которого мы хотим достичь. Обычно это 4 пробела или что-то еще, что дает клавиша табуляции (при ее нажатии курсор перемещается вправо). В следующем примере подготовка и установка находятся в крайнем левом углу, а промежуточные точки расположены на четыре пробела впереди:

1. Подготовка:
    1. ISO загружен.
    2. Записывается на USB.
2. Установка:
    1. USB вставлен в устройство.
    2. Это...

Это выглядело бы так:

1. Приготовление:
   1. ISO загружен.
   2. Он записывается на USB.
2. Установка:
   1. USB вставлен в оборудование.
   2. ОН..

Имейте в виду, что упорядоченные списки в Markdown всегда следуют порядку, лучше не сказать. Его можно создать с помощью 1., 1., 1., и вы увидите 1., 2., 3.. Чтобы разбить их, вам нужно добавить текст между ними с помощью двойного разрыва строки. И даже в этом случае, если вы затем поставите 2., счет продолжится.

Списки данных

Списки данных — это те, в которых после термина следует определение, и их можно создавать следующим образом (не поддерживается многими программами просмотра):

Срок 1
: Определение 1

Срок 2
: Определение 2а
: Определение 2б

Список дел

Списки задач можно создавать с помощью символа неупорядоченного списка («-», «*» или «+»), пробела и квадратных скобок. Если они с пустым местом, задача остается невыполненной; с "x" внутри, это сделано:

- [ ] Создать статью
- [x]Поздравить с Новым годом

Это выглядело бы так:

• Создать статью
• Поздравить с новым годом

Списки можно комбинировать, и здесь в игру вступают фантазия и потребности каждого.

Ссылки в Markdown

Есть несколько способов добавления ссылок в Markdown: быстрый или прямой, обычный и по ссылке. Самый быстрый - это добавьте ссылку как есть, с включенным протоколом. Например, https://linuxadictos.com будет отображаться как кликабельная ссылка в большинстве программ просмотра, совместимых с Markdown. Тогда мы имеем нормальный язык этого типа и ссылку.

Обычная ссылка помещается с текстом в квадратных скобках, а сама ссылка и ее название o подсказка (если есть, в кавычках) в скобках:

[Лучший блог о Linux](https://linuxadictos.com «Или мы попробуем»)

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

[Лучший блог о Linux][LXA] ... ... ... [LXA]: https://linuxadictos.com

Ссылки обычно размещаются в конце документа.

Если мы хотим, чтобы ссылка отображалась без гиперссылки, мы можем окружить ее обратным или открытым акцентом (`), это метод экранирования, о котором мы поговорим позже. Это придаст ему некоторое форматирование, но ни на что не будет ссылаться.

Ссылки на идентификаторы

Markdown также позволяет создавать ссылки на элементы с идентификатором. Первый способ сделать это наиболее распространен, но у меня он никогда не работал: {#el-id} необходимо добавить в заголовки сзади, а ссылка вместо URL-адреса должна включать идентификатор. Например, [to images](#images) приведет к следующему пункту, если ваш Markdown будет «## изображений в Markdown {#images}».

Есть еще два способа добавить ссылки к идентификаторам:

• Ссылки на автоматические заголовки. Некоторые текстовые процессоры и некоторые программы просмотра поддерживают эту функцию и добавляют идентификатор автоматически. Если заголовок «A test», идентификатор тот же, но все в нижнем регистре и с заменой пробелов дефисами. Синтаксис должен быть:

[Текст, который мы хотим отобразить](#a-test)

• Ссылки с идентификатором HTML: этот метод добавляет тег (например, «a», но это не обязательно) с желаемым идентификатором и без какого-либо текста между открывающими и закрывающими тегами, чтобы он действовал только как ссылка (). Ссылка будет точно такой же, как и в предыдущем пункте.

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

Эстетический трюк: если мы добавим где-нибудь в коде <style>* {scroll-behavior: smooth}</style>, мы увидим смещение; не прыгнет. Проблема заключается в том, что я объясню позже: некоторые области видимости могут показывать эту строку как есть, а не скрывать ее.

Изображения в Markdown

Если вы поняли предыдущий пункт, вы поймете и этот. Изображения добавляются практически так же, как и ссылки., с той основной разницей, что перед ним ставится восклицательный знак. Например:

![Обои Linux Mint](https://www.linuxadictos.com/wp-content/uploads/Fondos-de-screenla-de-Victoria.png «Доступно в январе»)

Из приведенного выше:

• ! указывает на то, что это изображение.
• [] Они содержат альтернативный текст, атрибут HTML «alt».
• () Они содержат ссылку на изображение, HTML-атрибут «src».
• Вы можете поместить информационный текст «заголовок» в HTML между кавычками. Не нужно.

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

[![Обои Linux Mint](https://www.linuxadictos.com/wp-content/uploads/Fundos-de-screenla-de-Victoria.png «Это ведет к DuckDuckGo»)](https://duckduckgo.com)

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

Датировка

Цитаты в Markdown создаются путем начала абзаца с символа «больше», например, сказал Паблинукс:

> Я думаю, тогда... Когда ты это ешь?

Это покажет:

Тогда я думаю... Когда ты это ешь?

Если бы нам нужно было вложить кавычки, использовались бы символы «больше, чем».

> Оригинальная цитата
>
> > То, что было сказано в цитате

Это выглядело бы так:

Оригинальная цитата

О чем говорилось в цитате

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

> Первая остроумная фраза
>
> Конец встречи

показал бы:

Первая остроумная фраза

Конец цитаты.

Код

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

(tab) sudo pacman -Сю

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

``` питон
Защитный тест():
    привет
```

Это будет показывать что-то вроде этого:

Горизонтальные линии

Горизонтальные линии в Markdown можно создавать, оставляя в строке только 3 или более звездочки (***), тире (—) или подчеркивания (___). Результат следующий:

Tablas

Таблицы в Markdown в основном создаются путем их изображения:

|Первый|Второй|Третий|
|:------|:------:|------:|
|Первое поле|Второе поле|Третье поле|
|Что-то|Что-то 2|Что-то 3|

Он покажет (но в другом формате):

Неважно, какой размер мы оставляем в ячейках.; язык будет их форматировать. Во второй строке, пожалуй, самой важной, мы можем указать, что текст выравнивается по левому, центральному или правому краю. Двоеточие (:) указывает, куда идет текст; наоборот, если мы хотим центрировать его, мы должны поставить двоеточие перед строкой и позади нее.

Математические формулы

Markdown также позволяет добавлять математические формулы. Например, вы можете включить онлайн-уравнение со знаком доллара впереди и позади него: $x2+y2=z^2$. Также блоки с двумя долларами:

$$\sum_{i=0}^ni^2 = \frac{(n^2+n)(2n+1)}{6}$$

Результат вышесказанного выглядит в VSCode следующим образом (с скобкой перед второй буквой n, которую я пропустил):

Экранирующие символы в Markdown

Иногда может возникнуть необходимость «экранировать» некоторые символы. Например, если мы поставим # в начале строки, а затем пробел, получится h1. Мы можем избежать этого, поставив перед собой обратную косую черту, вот так:

\# Заголовок

А так бы получилось как есть, без форматирования и без escape-символа. Есть еще несколько способов, но этот наиболее используемый и такой же, как и в других языках.

Уценка с помощью HTML

уценка частично поддерживает HTML-теги и правила CSS, но я бы на это не ставил. Не все зрители показывают одно и то же, и важно помнить об этом. Например, если мы используем GitHub Markdown и хотим выровнять изображение, используя <img align="left"> Мы заставим его «плавать» — плавание означает, что то, что находится внизу, поднимается и помещается рядом с ним — слева. Его можно положить на противоположную сторону, используя right, но опция center не работает, если она не заключена в блочный тег, например или .

Но это может быть вариант. Если мы хотим поместить текст в красный цвет, мы можем извлечь HTML и CSS, окружить его контейнером типа span и внутри тега добавить правила CSS в атрибут «style». Это может быть полезно, например, если мы хотим контролировать размер изображения, но, как я уже сказал, это не всегда работает.

Когда НЕ использовать Markdown

Markdown — это то, что есть, и он был разработан для быстрого создания контента для очень специфического использования. Его можно использовать для личных заметок или в качестве препроцессора HTML, но Не следует использовать его, если вам приходится работать в группе, которая его не использует.. Наиболее распространенным является использование текстовых процессоров, а точнее Word и его .docx, поэтому я бы не стал использовать Markdown, если планирую поделиться своей работой. Они, вероятно, даже не знают, как их просмотреть, если мы не дадим им ссылку на подобную статью ;)

Редакторы Markdown для Linux

Эта статья оказалась длиннее, чем ожидалось, и, возможно, стоит оставить ее для другого поста. Возможно, было бы неплохо упомянуть некоторые вскользь, например, Джоплин, Апостроф или Visual Studio Code для тех, кто хочет иметь все в одном месте. Как и средства просмотра, некоторые программы просмотра документов по умолчанию могут отображать их содержимое.

Что бы вы ни выбрали, для личных заметок стоит использовать Markdown. Попробуйте и вы мне скажете.

Таблица результатов